Microsoft.EventHub namespaces/eventhubs/consumergroups

  • Article

Bicep resource definition

The namespaces/eventhubs/consumergroups 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/namespaces/eventhubs/consumergroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs/consumergroups@2024-01-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    userMetadata: 'string'
  }
}

Property values

namespaces/eventhubs/consumergroups

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, periods, hyphens and underscores.

Start and end with letter or number.
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: eventhubs
properties Single item in List or Get Consumer group operation ConsumerGroupProperties

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an EventHubs namespace, Event Hub, & consumer group

Deploy to Azure		 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 Hub connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Hub connection.

ARM template resource definition

The namespaces/eventhubs/consumergroups 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/namespaces/eventhubs/consumergroups resource, add the following JSON to your template.

{
  "type": "Microsoft.EventHub/namespaces/eventhubs/consumergroups",
  "apiVersion": "2024-01-01",
  "name": "string",
  "properties": {
    "userMetadata": "string"
  }
}

Property values

namespaces/eventhubs/consumergroups

Name Description Value
type The resource type 'Microsoft.EventHub/namespaces/eventhubs/consumergroups'
apiVersion The resource api version '2024-01-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, periods, hyphens and underscores.

Start and end with letter or number.
properties Single item in List or Get Consumer group operation ConsumerGroupProperties

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an EventHubs namespace, Event Hub, & consumer group

Deploy to Azure		 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 Hub connection

Deploy to Azure		 Deploy Azure Data Explorer db with Event Hub connection.

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-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      userMetadata = "string"
    }
  })
}

Property values

namespaces/eventhubs/consumergroups

Name Description Value
type The resource type "Microsoft.EventHub/namespaces/eventhubs/consumergroups@2024-01-01"
name The resource name string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, periods, hyphens and underscores.

Start and end with letter or number.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: eventhubs
properties Single item in List or Get Consumer group operation ConsumerGroupProperties

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