Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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' = {
location: 'string'
name: 'string'
properties: {}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Event Hubs Cluster properties supplied in responses in List or Get operations. | ClusterProperties |
| sku | Properties of the cluster SKU. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ClusterProperties
| Name | Description | Value |
|---|
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) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Creates Event Hub cluster & namesapce in cluster | This template enables you to create EventHubs Cluster and a namespace in cluster |
| Creates Eventhub cluster, namesapce & eventhub | 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:
- Resource groups - See resource group deployment commands
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",
"properties": {
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-11-01' |
| location | Resource location. | string |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Event Hubs Cluster properties supplied in responses in List or Get operations. | ClusterProperties |
| sku | Properties of the cluster SKU. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.EventHub/clusters' |
ClusterProperties
| Name | Description | Value |
|---|
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) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Creates Event Hub cluster & namesapce in cluster |
This template enables you to create EventHubs Cluster and a namespace in cluster |
| Creates Eventhub cluster, namesapce & eventhub |
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"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| properties | Event Hubs Cluster properties supplied in responses in List or Get operations. | ClusterProperties |
| sku | Properties of the cluster SKU. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.EventHub/clusters@2021-11-01" |
ClusterProperties
| Name | Description | Value |
|---|
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) |
TrackedResourceTags
| Name | Description | Value |
|---|