1. Packages
  2. Azure Classic
  3. API Docs
  4. streamanalytics
  5. Cluster

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.streamanalytics.Cluster

Explore with Pulumi AI

Manages a Stream Analytics Cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleCluster = new azure.streamanalytics.Cluster("example", {
    name: "examplestreamanalyticscluster",
    resourceGroupName: example.name,
    location: example.location,
    streamingCapacity: 36,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_cluster = azure.streamanalytics.Cluster("example",
    name="examplestreamanalyticscluster",
    resource_group_name=example.name,
    location=example.location,
    streaming_capacity=36)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/streamanalytics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = streamanalytics.NewCluster(ctx, "example", &streamanalytics.ClusterArgs{
			Name:              pulumi.String("examplestreamanalyticscluster"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			StreamingCapacity: pulumi.Int(36),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleCluster = new Azure.StreamAnalytics.Cluster("example", new()
    {
        Name = "examplestreamanalyticscluster",
        ResourceGroupName = example.Name,
        Location = example.Location,
        StreamingCapacity = 36,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.streamanalytics.Cluster;
import com.pulumi.azure.streamanalytics.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .name("examplestreamanalyticscluster")
            .resourceGroupName(example.name())
            .location(example.location())
            .streamingCapacity(36)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleCluster:
    type: azure:streamanalytics:Cluster
    name: example
    properties:
      name: examplestreamanalyticscluster
      resourceGroupName: ${example.name}
      location: ${example.location}
      streamingCapacity: 36
Copy

Create Cluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            streaming_capacity: Optional[int] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: azure:streamanalytics:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleclusterResourceResourceFromStreamanalyticscluster = new Azure.StreamAnalytics.Cluster("exampleclusterResourceResourceFromStreamanalyticscluster", new()
{
    ResourceGroupName = "string",
    StreamingCapacity = 0,
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := streamanalytics.NewCluster(ctx, "exampleclusterResourceResourceFromStreamanalyticscluster", &streamanalytics.ClusterArgs{
	ResourceGroupName: pulumi.String("string"),
	StreamingCapacity: pulumi.Int(0),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleclusterResourceResourceFromStreamanalyticscluster = new Cluster("exampleclusterResourceResourceFromStreamanalyticscluster", ClusterArgs.builder()
    .resourceGroupName("string")
    .streamingCapacity(0)
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
examplecluster_resource_resource_from_streamanalyticscluster = azure.streamanalytics.Cluster("exampleclusterResourceResourceFromStreamanalyticscluster",
    resource_group_name="string",
    streaming_capacity=0,
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const exampleclusterResourceResourceFromStreamanalyticscluster = new azure.streamanalytics.Cluster("exampleclusterResourceResourceFromStreamanalyticscluster", {
    resourceGroupName: "string",
    streamingCapacity: 0,
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:streamanalytics:Cluster
properties:
    location: string
    name: string
    resourceGroupName: string
    streamingCapacity: 0
    tags:
        string: string
Copy

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Cluster resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
StreamingCapacity This property is required. int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
Location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Stream Analytics.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
StreamingCapacity This property is required. int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
Location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Stream Analytics.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity This property is required. Integer
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
location Changes to this property will trigger replacement. String
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Stream Analytics.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity This property is required. number
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Stream Analytics.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streaming_capacity This property is required. int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
location Changes to this property will trigger replacement. str
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Stream Analytics.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity This property is required. Number
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
location Changes to this property will trigger replacement. String
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags which should be assigned to the Stream Analytics.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        streaming_capacity: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
resources:  _:    type: azure:streamanalytics:Cluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
StreamingCapacity int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Stream Analytics.
Location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
StreamingCapacity int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
Tags map[string]string
A mapping of tags which should be assigned to the Stream Analytics.
location Changes to this property will trigger replacement. String
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity Integer
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
tags Map<String,String>
A mapping of tags which should be assigned to the Stream Analytics.
location Changes to this property will trigger replacement. string
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity number
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Stream Analytics.
location Changes to this property will trigger replacement. str
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streaming_capacity int
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Stream Analytics.
location Changes to this property will trigger replacement. String
The Azure Region where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Stream Analytics Cluster. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Stream Analytics Cluster should exist. Changing this forces a new resource to be created.
streamingCapacity Number
The number of streaming units supported by the Cluster. Accepted values are multiples of 36 in the range of 36 to 216.
tags Map<String>
A mapping of tags which should be assigned to the Stream Analytics.

Import

Stream Analytics Clusters can be imported using the resource id, e.g.

$ pulumi import azure:streamanalytics/cluster:Cluster example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.StreamAnalytics/clusters/cluster1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.