Microsoft.EventHub clusters 2022-01-01-preview
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@2022-01-01-preview' = {
location: 'string'
name: 'string'
properties: {
supportsScaling: bool
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
ClusterProperties
| Name | Description | Value |
|---|---|---|
| supportsScaling | A value that indicates whether Scaling is Supported. | bool |
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) |
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 |
TrackedResourceTags
| Name | Description | Value |
|---|
Quickstart samples
The following quickstart samples deploy 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": "2022-01-01-preview",
"name": "string",
"location": "string",
"properties": {
"supportsScaling": "bool"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
ClusterProperties
| Name | Description | Value |
|---|---|---|
| supportsScaling | A value that indicates whether Scaling is Supported. | bool |
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) |
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-01-01-preview' |
| 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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Quickstart templates
The following 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@2022-01-01-preview"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
supportsScaling = bool
}
})
}
Property values
ClusterProperties
| Name | Description | Value |
|---|---|---|
| supportsScaling | A value that indicates whether Scaling is Supported. | bool |
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) |
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@2022-01-01-preview" |
TrackedResourceTags
| Name | Description | Value |
|---|