Microsoft.EventHub namespaces/eventhubs/consumergroups 2018-01-01-preview

Template format

To create a Microsoft.EventHub/namespaces/eventhubs/consumergroups resource, add the following JSON to the resources section of your template.

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

Property values

The following tables describe the values you need to set in the schema.

Microsoft.EventHub/namespaces/eventhubs/consumergroups object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The consumer group name
type enum Yes For JSON -consumergroups
-or-
Microsoft.EventHub/namespaces/eventhubs/consumergroups

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2018-01-01-preview
properties object Yes Single item in List or Get Consumer group operation - ConsumerGroupProperties object

ConsumerGroupProperties object

Name Type Required Value
userMetadata string No 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.