Microsoft.EventHub clusters 2021-11-01

Bicep resource definition

The clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/clusters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventHub/clusters@2021-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'Dedicated'
  }
  properties: {}
}

Property values

clusters

Name Description Value
name The resource name string (required)

Character limit: 6-50

Valid characters:
Alphanumerics and hyphens.

Start with letter. End with letter or number.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Properties of the cluster SKU. ClusterSku
properties Event Hubs Cluster properties supplied in responses in List or Get operations. ClusterProperties

ClusterProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ClusterSku

Name Description Value
capacity The quantity of Event Hubs Cluster Capacity Units contained in this cluster. int

Constraints:
Min value = 1
name Name of this SKU. 'Dedicated' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Creates Event Hub cluster & namesapce in cluster

Deploy to Azure
This template enables you to create EventHubs Cluster and a namespace in cluster
Creates Eventhub cluster, namesapce & eventhub

Deploy to Azure
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster

ARM template resource definition

The clusters resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/clusters resource, add the following JSON to your template.

{
  "type": "Microsoft.EventHub/clusters",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "Dedicated"
  },
  "properties": {}
}

Property values

clusters

Name Description Value
type The resource type 'Microsoft.EventHub/clusters'
apiVersion The resource api version '2021-11-01'
name The resource name string (required)

Character limit: 6-50

Valid characters:
Alphanumerics and hyphens.

Start with letter. End with letter or number.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Properties of the cluster SKU. ClusterSku
properties Event Hubs Cluster properties supplied in responses in List or Get operations. ClusterProperties

ClusterProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ClusterSku

Name Description Value
capacity The quantity of Event Hubs Cluster Capacity Units contained in this cluster. int

Constraints:
Min value = 1
name Name of this SKU. 'Dedicated' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Creates Event Hub cluster & namesapce in cluster

Deploy to Azure
This template enables you to create EventHubs Cluster and a namespace in cluster
Creates Eventhub cluster, namesapce & eventhub

Deploy to Azure
This template enables you to create EventHubs Cluster, namespace and eventhub in cluster

Terraform (AzAPI provider) resource definition

The clusters resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/clusters resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/clusters@2021-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {}
    sku = {
      capacity = int
      name = "Dedicated"
    }
  })
}

Property values

clusters

Name Description Value
type The resource type "Microsoft.EventHub/clusters@2021-11-01"
name The resource name string (required)

Character limit: 6-50

Valid characters:
Alphanumerics and hyphens.

Start with letter. End with letter or number.
location Resource location. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku Properties of the cluster SKU. ClusterSku
properties Event Hubs Cluster properties supplied in responses in List or Get operations. ClusterProperties

ClusterProperties

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ClusterSku

Name Description Value
capacity The quantity of Event Hubs Cluster Capacity Units contained in this cluster. int

Constraints:
Min value = 1
name Name of this SKU. "Dedicated" (required)