Cluster

Manages an EventHub Cluster

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.Core.ResourceGroup("example", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US 2",
        });
        var test = new Azure.EventHub.Cluster("test", new Azure.EventHub.ClusterArgs
        {
            ResourceGroupName = azurerm_resource_group.Test.Name,
            Location = azurerm_resource_group.Test.Location,
            SkuName = "Dedicated_1",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/eventhub"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err = core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
            Location: pulumi.String("West US 2"),
        })
        if err != nil {
            return err
        }
        _, err = eventhub.NewCluster(ctx, "test", &eventhub.ClusterArgs{
            ResourceGroupName: pulumi.String(azurerm_resource_group.Test.Name),
            Location:          pulumi.String(azurerm_resource_group.Test.Location),
            SkuName:           pulumi.String("Dedicated_1"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West US 2")
test = azure.eventhub.Cluster("test",
    resource_group_name=azurerm_resource_group["test"]["name"],
    location=azurerm_resource_group["test"]["location"],
    sku_name="Dedicated_1")

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

const example = new azure.core.ResourceGroup("example", {location: "West US 2"});
const test = new azure.eventhub.Cluster("test", {
    resourceGroupName: azurerm_resource_group.test.name,
    location: azurerm_resource_group.test.location,
    skuName: "Dedicated_1",
});

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, location=None, name=None, resource_group_name=None, sku_name=None, tags=None, __props__=None);

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 {[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 Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, location=None, name=None, resource_group_name=None, sku_name=None, tags=None, __props__=None);

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)

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.

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 {[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 Dict[str, str]: A mapping of tags to assign to the resource.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud