1. Packages
  2. Azure Native
  3. API Docs
  4. streamanalytics
  5. Cluster
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.streamanalytics.Cluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    A Stream Analytics Cluster object Azure REST API version: 2020-03-01. Prior API version in Azure Native 1.x: 2020-03-01-preview

    Example Usage

    Create a new cluster

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var cluster = new AzureNative.StreamAnalytics.Cluster("cluster", new()
        {
            ClusterName = "An Example Cluster",
            Location = "North US",
            ResourceGroupName = "sjrg",
            Sku = new AzureNative.StreamAnalytics.Inputs.ClusterSkuArgs
            {
                Capacity = 48,
                Name = "Default",
            },
            Tags = 
            {
                { "key", "value" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/streamanalytics/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := streamanalytics.NewCluster(ctx, "cluster", &streamanalytics.ClusterArgs{
    			ClusterName:       pulumi.String("An Example Cluster"),
    			Location:          pulumi.String("North US"),
    			ResourceGroupName: pulumi.String("sjrg"),
    			Sku: &streamanalytics.ClusterSkuArgs{
    				Capacity: pulumi.Int(48),
    				Name:     pulumi.String("Default"),
    			},
    			Tags: pulumi.StringMap{
    				"key": pulumi.String("value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.streamanalytics.Cluster;
    import com.pulumi.azurenative.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 cluster = new Cluster("cluster", ClusterArgs.builder()        
                .clusterName("An Example Cluster")
                .location("North US")
                .resourceGroupName("sjrg")
                .sku(Map.ofEntries(
                    Map.entry("capacity", 48),
                    Map.entry("name", "Default")
                ))
                .tags(Map.of("key", "value"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    cluster = azure_native.streamanalytics.Cluster("cluster",
        cluster_name="An Example Cluster",
        location="North US",
        resource_group_name="sjrg",
        sku=azure_native.streamanalytics.ClusterSkuArgs(
            capacity=48,
            name="Default",
        ),
        tags={
            "key": "value",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const cluster = new azure_native.streamanalytics.Cluster("cluster", {
        clusterName: "An Example Cluster",
        location: "North US",
        resourceGroupName: "sjrg",
        sku: {
            capacity: 48,
            name: "Default",
        },
        tags: {
            key: "value",
        },
    });
    
    resources:
      cluster:
        type: azure-native:streamanalytics:Cluster
        properties:
          clusterName: An Example Cluster
          location: North US
          resourceGroupName: sjrg
          sku:
            capacity: 48
            name: Default
          tags:
            key: value
    

    Create Cluster Resource

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                cluster_name: Optional[str] = None,
                location: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                sku: Optional[ClusterSkuArgs] = None,
                tags: Optional[Mapping[str, str]] = None)
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = 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-native:streamanalytics:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Cluster resource accepts the following input properties:

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    ClusterName string

    The name of the cluster.

    Location string

    The geo-location where the resource lives

    Sku Pulumi.AzureNative.StreamAnalytics.Inputs.ClusterSku

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    Tags Dictionary<string, string>

    Resource tags.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    ClusterName string

    The name of the cluster.

    Location string

    The geo-location where the resource lives

    Sku ClusterSkuArgs

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    Tags map[string]string

    Resource tags.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    clusterName String

    The name of the cluster.

    location String

    The geo-location where the resource lives

    sku ClusterSku

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    tags Map<String,String>

    Resource tags.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    clusterName string

    The name of the cluster.

    location string

    The geo-location where the resource lives

    sku ClusterSku

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    tags {[key: string]: string}

    Resource tags.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    cluster_name str

    The name of the cluster.

    location str

    The geo-location where the resource lives

    sku ClusterSkuArgs

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    tags Mapping[str, str]

    Resource tags.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    clusterName String

    The name of the cluster.

    location String

    The geo-location where the resource lives

    sku Property Map

    The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.

    tags Map<String>

    Resource tags.

    Outputs

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

    CapacityAllocated int

    Represents the number of streaming units currently being used on the cluster.

    CapacityAssigned int

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    ClusterId string

    Unique identifier for the cluster.

    CreatedDate string

    The date this cluster was created.

    Etag string

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    ProvisioningState string

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    Type string

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    CapacityAllocated int

    Represents the number of streaming units currently being used on the cluster.

    CapacityAssigned int

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    ClusterId string

    Unique identifier for the cluster.

    CreatedDate string

    The date this cluster was created.

    Etag string

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The name of the resource

    ProvisioningState string

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    Type string

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    capacityAllocated Integer

    Represents the number of streaming units currently being used on the cluster.

    capacityAssigned Integer

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    clusterId String

    Unique identifier for the cluster.

    createdDate String

    The date this cluster was created.

    etag String

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    provisioningState String

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    type String

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    capacityAllocated number

    Represents the number of streaming units currently being used on the cluster.

    capacityAssigned number

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    clusterId string

    Unique identifier for the cluster.

    createdDate string

    The date this cluster was created.

    etag string

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The name of the resource

    provisioningState string

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    type string

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    capacity_allocated int

    Represents the number of streaming units currently being used on the cluster.

    capacity_assigned int

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    cluster_id str

    Unique identifier for the cluster.

    created_date str

    The date this cluster was created.

    etag str

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The name of the resource

    provisioning_state str

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    type str

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    capacityAllocated Number

    Represents the number of streaming units currently being used on the cluster.

    capacityAssigned Number

    Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.

    clusterId String

    Unique identifier for the cluster.

    createdDate String

    The date this cluster was created.

    etag String

    The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The name of the resource

    provisioningState String

    The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled

    type String

    The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

    Supporting Types

    ClusterSku, ClusterSkuArgs

    Capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    Name string | Pulumi.AzureNative.StreamAnalytics.ClusterSkuName

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    Capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    Name string | ClusterSkuName

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity Integer

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name String | ClusterSkuName

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity number

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name string | ClusterSkuName

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name str | ClusterSkuName

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity Number

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name String | "Default"

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    ClusterSkuName, ClusterSkuNameArgs

    Default
    Default

    The default SKU.

    ClusterSkuNameDefault
    Default

    The default SKU.

    Default
    Default

    The default SKU.

    Default
    Default

    The default SKU.

    DEFAULT
    Default

    The default SKU.

    "Default"
    Default

    The default SKU.

    ClusterSkuResponse, ClusterSkuResponseArgs

    Capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    Name string

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    Capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    Name string

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity Integer

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name String

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity number

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name string

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity int

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name str

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    capacity Number

    Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.

    name String

    Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:streamanalytics:Cluster An Example Cluster /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName} 
    

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi