Microsoft.EventHub namespaces/eventhubs/consumergroups 2024-05-01-preview
Bicep resource definition
The namespaces/eventhubs/consumergroups 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/namespaces/eventhubs/consumergroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs/consumergroups@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
userMetadata: 'string'
}
}
Property values
ConsumerGroupProperties
| Name | Description | Value |
|---|---|---|
| userMetadata | User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. | string |
Microsoft.EventHub/namespaces/eventhubs/consumergroups
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: namespaces/eventhubs |
| properties | Single item in List or Get Consumer group operation | ConsumerGroupProperties |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Create an EventHubs namespace, Event Hub, & consumer group | This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Deploy Azure Data Explorer db with Event Grid connection | Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection | Deploy Azure Data Explorer db with Event Hub connection. |
| FrontDoor CDN with WAF, Domains and Logs to EventHub | This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
ARM template resource definition
The namespaces/eventhubs/consumergroups 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/namespaces/eventhubs/consumergroups resource, add the following JSON to your template.
{
"type": "Microsoft.EventHub/namespaces/eventhubs/consumergroups",
"apiVersion": "2024-05-01-preview",
"name": "string",
"properties": {
"userMetadata": "string"
}
}
Property values
ConsumerGroupProperties
| Name | Description | Value |
|---|---|---|
| userMetadata | User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. | string |
Microsoft.EventHub/namespaces/eventhubs/consumergroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| properties | Single item in List or Get Consumer group operation | ConsumerGroupProperties |
| type | The resource type | 'Microsoft.EventHub/namespaces/eventhubs/consumergroups' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an EventHubs namespace, Event Hub, & consumer group |
This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group. |
| Deploy Azure Data Explorer db with Event Grid connection |
Deploy Azure Data Explorer db with Event Grid connection. |
| Deploy Azure Data Explorer db with Event Hub connection |
Deploy Azure Data Explorer db with Event Hub connection. |
| FrontDoor CDN with WAF, Domains and Logs to EventHub |
This template creates a new Azure FrontDoor cdn profile. Create WAF with custom and managed rules, cdn routes, origin and groups with their association with WAF and routes, configures custom domains, create event hub and diagnostic settings for sending CDN access logs using event hub. |
Terraform (AzAPI provider) resource definition
The namespaces/eventhubs/consumergroups 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/namespaces/eventhubs/consumergroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs/consumergroups@2024-05-01-preview"
name = "string"
body = jsonencode({
properties = {
userMetadata = "string"
}
})
}
Property values
ConsumerGroupProperties
| Name | Description | Value |
|---|---|---|
| userMetadata | User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored. | string |
Microsoft.EventHub/namespaces/eventhubs/consumergroups
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: namespaces/eventhubs |
| properties | Single item in List or Get Consumer group operation | ConsumerGroupProperties |
| type | The resource type | "Microsoft.EventHub/namespaces/eventhubs/consumergroups@2024-05-01-preview" |