Microsoft.EventHub namespaces/eventhubs/consumergroups

  • Статья
  • Чтение занимает 2 мин

The namespaces/eventhubs/consumergroups resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

For a list of changed properties in each API version, see change log.

Template format

To create a Microsoft.EventHub/namespaces/eventhubs/consumergroups resource, add the following Bicep or JSON to your template.

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

Property values

namespaces/eventhubs/consumergroups

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.EventHub/namespaces/eventhubs/consumergroups'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2022-01-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 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
Deploy Azure Data Explorer db with Event Hub connection.

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