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:
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@2025-05-01-preview' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
platformCapabilities: {
confidentialCompute: {
mode: 'string'
}
}
supportsScaling: bool
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | 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 |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| sku | Properties of the cluster SKU. | ClusterSku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| platformCapabilities | PlatformCapabilities | |
| 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) |
ClusterTags
| Name | Description | Value |
|---|
ConfidentialCompute
| Name | Description | Value |
|---|---|---|
| mode | Setting to Enable or Disable Confidential Compute | 'Disabled' 'Enabled' |
PlatformCapabilities
| Name | Description | Value |
|---|---|---|
| confidentialCompute | ConfidentialCompute |
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:
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": "2025-05-01-preview",
"name": "string",
"location": "string",
"properties": {
"platformCapabilities": {
"confidentialCompute": {
"mode": "string"
}
},
"supportsScaling": "bool"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-05-01-preview' |
| location | The geo-location where the resource lives | 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 |
|---|---|---|
| platformCapabilities | PlatformCapabilities | |
| 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) |
ClusterTags
| Name | Description | Value |
|---|
ConfidentialCompute
| Name | Description | Value |
|---|---|---|
| mode | Setting to Enable or Disable Confidential Compute | 'Disabled' 'Enabled' |
PlatformCapabilities
| Name | Description | Value |
|---|---|---|
| confidentialCompute | ConfidentialCompute |
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:
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@2025-05-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
platformCapabilities = {
confidentialCompute = {
mode = "string"
}
}
supportsScaling = bool
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
Microsoft.EventHub/clusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | string Constraints: Min length = 6 Max length = 50 (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (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@2025-05-01-preview" |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| platformCapabilities | PlatformCapabilities | |
| 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) |
ClusterTags
| Name | Description | Value |
|---|
ConfidentialCompute
| Name | Description | Value |
|---|---|---|
| mode | Setting to Enable or Disable Confidential Compute | 'Disabled' 'Enabled' |
PlatformCapabilities
| Name | Description | Value |
|---|---|---|
| confidentialCompute | ConfidentialCompute |
Usage Examples
Terraform Samples
A basic example of deploying EventHub Cluster.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "cluster" {
type = "Microsoft.EventHub/clusters@2021-11-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
sku = {
capacity = 1
name = "Dedicated"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}