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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.eventhub.Cluster

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an EventHub 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 test = new azure.eventhub.Cluster("test", {
    name: "example",
    resourceGroupName: example.name,
    location: example.location,
    skuName: "Dedicated_1",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
test = azure.eventhub.Cluster("test",
    name="example",
    resource_group_name=example.name,
    location=example.location,
    sku_name="Dedicated_1")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventhub"
	"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 = eventhub.NewCluster(ctx, "test", &eventhub.ClusterArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			SkuName:           pulumi.String("Dedicated_1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 test = new Azure.EventHub.Cluster("test", new()
    {
        Name = "example",
        ResourceGroupName = example.Name,
        Location = example.Location,
        SkuName = "Dedicated_1",
    });

});

    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.eventhub.Cluster;
import com.pulumi.azure.eventhub.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 test = new Cluster("test", ClusterArgs.builder()
            .name("example")
            .resourceGroupName(example.name())
            .location(example.location())
            .skuName("Dedicated_1")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  test:
    type: azure:eventhub:Cluster
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      skuName: Dedicated_1

    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,
            sku_name: Optional[str] = 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: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 exampleclusterResourceResourceFromEventhubcluster = new Azure.EventHub.Cluster("exampleclusterResourceResourceFromEventhubcluster", new()
{
    ResourceGroupName = "string",
    SkuName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := eventhub.NewCluster(ctx, "exampleclusterResourceResourceFromEventhubcluster", &eventhub.ClusterArgs{
	ResourceGroupName: pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleclusterResourceResourceFromEventhubcluster = new Cluster("exampleclusterResourceResourceFromEventhubcluster", ClusterArgs.builder()
    .resourceGroupName("string")
    .skuName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    examplecluster_resource_resource_from_eventhubcluster = azure.eventhub.Cluster("exampleclusterResourceResourceFromEventhubcluster",
    resource_group_name="string",
    sku_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

    const exampleclusterResourceResourceFromEventhubcluster = new azure.eventhub.Cluster("exampleclusterResourceResourceFromEventhubcluster", {
    resourceGroupName: "string",
    skuName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: azure:eventhub:Cluster
properties:
    location: string
    name: string
    resourceGroupName: string
    skuName: string
    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
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    SkuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ResourceGroupName string
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    SkuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName String
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    resourceGroupName string
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    resource_group_name str
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    sku_name str
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    resourceGroupName String
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName String
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.

    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,
        sku_name: Optional[str] = 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    SkuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    SkuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName String
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName string
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    sku_name str
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the EventHub Cluster resource. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which the EventHub Cluster exists. Changing this forces a new resource to be created.
    skuName String
    The SKU name of the EventHub Cluster. The only supported value at this time is Dedicated_1.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Import

    EventHub Cluster’s can be imported using the resource id, e.g.

    $ pulumi import azure:eventhub/cluster:Cluster cluster1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/clusters/cluster1

    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure