Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.15.0 published on Wednesday, Aug 17, 2022 by Pulumi

Cluster

Manages an EventHub Cluster

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

    var test = new Azure.EventHub.Cluster("test", new()
    {
        ResourceGroupName = example.Name,
        Location = example.Location,
        SkuName = "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{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = eventhub.NewCluster(ctx, "test", &eventhub.ClusterArgs{
			ResourceGroupName: example.Name,
			Location:          example.Location,
			SkuName:           pulumi.String("Dedicated_1"),
		})
		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.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()        
            .location("West Europe")
            .build());

        var test = new Cluster("test", ClusterArgs.builder()        
            .resourceGroupName(example.name())
            .location(example.location())
            .skuName("Dedicated_1")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example", location="West Europe")
test = azure.eventhub.Cluster("test",
    resource_group_name=example.name,
    location=example.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 Europe"});
const test = new azure.eventhub.Cluster("test", {
    resourceGroupName: example.name,
    location: example.location,
    skuName: "Dedicated_1",
});
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  test:
    type: azure:eventhub:Cluster
    properties:
      resourceGroupName: ${example.name}
      location: ${example.location}
      skuName: Dedicated_1

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: 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)
@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:eventhub: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 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 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
@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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.