1. Packages
  2. Azure Native
  3. API Docs
  4. eventhub
  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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.eventhub.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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Single Event Hubs Cluster resource in List or Get operations. Azure REST API version: 2022-10-01-preview. Prior API version in Azure Native 1.x: 2018-01-01-preview.

    Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.

    Example Usage

    ClusterPut

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var cluster = new AzureNative.EventHub.Cluster("cluster", new()
        {
            ClusterName = "testCluster",
            Location = "South Central US",
            ResourceGroupName = "myResourceGroup",
            Sku = new AzureNative.EventHub.Inputs.ClusterSkuArgs
            {
                Capacity = 1,
                Name = AzureNative.EventHub.ClusterSkuName.Dedicated,
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
            },
        });
    
    });
    
    package main
    
    import (
    	eventhub "github.com/pulumi/pulumi-azure-native-sdk/eventhub/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := eventhub.NewCluster(ctx, "cluster", &eventhub.ClusterArgs{
    			ClusterName:       pulumi.String("testCluster"),
    			Location:          pulumi.String("South Central US"),
    			ResourceGroupName: pulumi.String("myResourceGroup"),
    			Sku: &eventhub.ClusterSkuArgs{
    				Capacity: pulumi.Int(1),
    				Name:     pulumi.String(eventhub.ClusterSkuNameDedicated),
    			},
    			Tags: pulumi.StringMap{
    				"tag1": pulumi.String("value1"),
    				"tag2": pulumi.String("value2"),
    			},
    		})
    		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.eventhub.Cluster;
    import com.pulumi.azurenative.eventhub.ClusterArgs;
    import com.pulumi.azurenative.eventhub.inputs.ClusterSkuArgs;
    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("testCluster")
                .location("South Central US")
                .resourceGroupName("myResourceGroup")
                .sku(ClusterSkuArgs.builder()
                    .capacity(1)
                    .name("Dedicated")
                    .build())
                .tags(Map.ofEntries(
                    Map.entry("tag1", "value1"),
                    Map.entry("tag2", "value2")
                ))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    cluster = azure_native.eventhub.Cluster("cluster",
        cluster_name="testCluster",
        location="South Central US",
        resource_group_name="myResourceGroup",
        sku={
            "capacity": 1,
            "name": azure_native.eventhub.ClusterSkuName.DEDICATED,
        },
        tags={
            "tag1": "value1",
            "tag2": "value2",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const cluster = new azure_native.eventhub.Cluster("cluster", {
        clusterName: "testCluster",
        location: "South Central US",
        resourceGroupName: "myResourceGroup",
        sku: {
            capacity: 1,
            name: azure_native.eventhub.ClusterSkuName.Dedicated,
        },
        tags: {
            tag1: "value1",
            tag2: "value2",
        },
    });
    
    resources:
      cluster:
        type: azure-native:eventhub:Cluster
        properties:
          clusterName: testCluster
          location: South Central US
          resourceGroupName: myResourceGroup
          sku:
            capacity: 1
            name: Dedicated
          tags:
            tag1: value1
            tag2: value2
    

    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,
                cluster_name: Optional[str] = None,
                location: Optional[str] = None,
                sku: Optional[ClusterSkuArgs] = None,
                supports_scaling: Optional[bool] = 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-native:eventhub:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Constructor example

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

    var exampleclusterResourceResourceFromEventhub = new AzureNative.EventHub.Cluster("exampleclusterResourceResourceFromEventhub", new()
    {
        ResourceGroupName = "string",
        ClusterName = "string",
        Location = "string",
        Sku = new AzureNative.EventHub.Inputs.ClusterSkuArgs
        {
            Name = "string",
            Capacity = 0,
        },
        SupportsScaling = false,
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := eventhub.NewCluster(ctx, "exampleclusterResourceResourceFromEventhub", &eventhub.ClusterArgs{
    	ResourceGroupName: pulumi.String("string"),
    	ClusterName:       pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	Sku: &eventhub.ClusterSkuArgs{
    		Name:     pulumi.String("string"),
    		Capacity: pulumi.Int(0),
    	},
    	SupportsScaling: pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleclusterResourceResourceFromEventhub = new Cluster("exampleclusterResourceResourceFromEventhub", ClusterArgs.builder()
        .resourceGroupName("string")
        .clusterName("string")
        .location("string")
        .sku(ClusterSkuArgs.builder()
            .name("string")
            .capacity(0)
            .build())
        .supportsScaling(false)
        .tags(Map.of("string", "string"))
        .build());
    
    examplecluster_resource_resource_from_eventhub = azure_native.eventhub.Cluster("exampleclusterResourceResourceFromEventhub",
        resource_group_name="string",
        cluster_name="string",
        location="string",
        sku={
            "name": "string",
            "capacity": 0,
        },
        supports_scaling=False,
        tags={
            "string": "string",
        })
    
    const exampleclusterResourceResourceFromEventhub = new azure_native.eventhub.Cluster("exampleclusterResourceResourceFromEventhub", {
        resourceGroupName: "string",
        clusterName: "string",
        location: "string",
        sku: {
            name: "string",
            capacity: 0,
        },
        supportsScaling: false,
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:eventhub:Cluster
    properties:
        clusterName: string
        location: string
        resourceGroupName: string
        sku:
            capacity: 0
            name: string
        supportsScaling: false
        tags:
            string: string
    

    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
    Name of the resource group within the azure subscription.
    ClusterName string
    The name of the Event Hubs Cluster.
    Location string
    Resource location.
    Sku Pulumi.AzureNative.EventHub.Inputs.ClusterSku
    Properties of the cluster SKU.
    SupportsScaling bool
    A value that indicates whether Scaling is Supported.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    Name of the resource group within the azure subscription.
    ClusterName string
    The name of the Event Hubs Cluster.
    Location string
    Resource location.
    Sku ClusterSkuArgs
    Properties of the cluster SKU.
    SupportsScaling bool
    A value that indicates whether Scaling is Supported.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    Name of the resource group within the azure subscription.
    clusterName String
    The name of the Event Hubs Cluster.
    location String
    Resource location.
    sku ClusterSku
    Properties of the cluster SKU.
    supportsScaling Boolean
    A value that indicates whether Scaling is Supported.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    Name of the resource group within the azure subscription.
    clusterName string
    The name of the Event Hubs Cluster.
    location string
    Resource location.
    sku ClusterSku
    Properties of the cluster SKU.
    supportsScaling boolean
    A value that indicates whether Scaling is Supported.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    Name of the resource group within the azure subscription.
    cluster_name str
    The name of the Event Hubs Cluster.
    location str
    Resource location.
    sku ClusterSkuArgs
    Properties of the cluster SKU.
    supports_scaling bool
    A value that indicates whether Scaling is Supported.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    Name of the resource group within the azure subscription.
    clusterName String
    The name of the Event Hubs Cluster.
    location String
    Resource location.
    sku Property Map
    Properties of the cluster SKU.
    supportsScaling Boolean
    A value that indicates whether Scaling is Supported.
    tags Map<String>
    Resource tags.

    Outputs

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

    CreatedAt string
    The UTC time when the Event Hubs Cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    Name string
    The name of the resource
    Status string
    Status of the Cluster resource
    SystemData Pulumi.AzureNative.EventHub.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UpdatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    CreatedAt string
    The UTC time when the Event Hubs Cluster was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    Name string
    The name of the resource
    Status string
    Status of the Cluster resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    UpdatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    createdAt String
    The UTC time when the Event Hubs Cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    metricId String
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name String
    The name of the resource
    status String
    Status of the Cluster resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt String
    The UTC time when the Event Hubs Cluster was last updated.
    createdAt string
    The UTC time when the Event Hubs Cluster was created.
    id string
    The provider-assigned unique ID for this managed resource.
    metricId string
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name string
    The name of the resource
    status string
    Status of the Cluster resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt string
    The UTC time when the Event Hubs Cluster was last updated.
    created_at str
    The UTC time when the Event Hubs Cluster was created.
    id str
    The provider-assigned unique ID for this managed resource.
    metric_id str
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name str
    The name of the resource
    status str
    Status of the Cluster resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updated_at str
    The UTC time when the Event Hubs Cluster was last updated.
    createdAt String
    The UTC time when the Event Hubs Cluster was created.
    id String
    The provider-assigned unique ID for this managed resource.
    metricId String
    The metric ID of the cluster resource. Provided by the service and not modifiable by the user.
    name String
    The name of the resource
    status String
    Status of the Cluster resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    updatedAt String
    The UTC time when the Event Hubs Cluster was last updated.

    Supporting Types

    ClusterSku, ClusterSkuArgs

    Name string | Pulumi.AzureNative.EventHub.ClusterSkuName
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    Name string | ClusterSkuName
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String | ClusterSkuName
    Name of this SKU.
    capacity Integer
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name string | ClusterSkuName
    Name of this SKU.
    capacity number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name str | ClusterSkuName
    Name of this SKU.
    capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String | "Dedicated"
    Name of this SKU.
    capacity Number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

    ClusterSkuName, ClusterSkuNameArgs

    Dedicated
    Dedicated
    ClusterSkuNameDedicated
    Dedicated
    Dedicated
    Dedicated
    Dedicated
    Dedicated
    DEDICATED
    Dedicated
    "Dedicated"
    Dedicated

    ClusterSkuResponse, ClusterSkuResponseArgs

    Name string
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    Name string
    Name of this SKU.
    Capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String
    Name of this SKU.
    capacity Integer
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name string
    Name of this SKU.
    capacity number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name str
    Name of this SKU.
    capacity int
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.
    name String
    Name of this SKU.
    capacity Number
    The quantity of Event Hubs Cluster Capacity Units contained in this cluster.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:eventhub:Cluster testCluster /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName} 
    

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

    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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi