Azure Event Hubs · Schema

Azure Event Hubs Consumer Group

A consumer group is a view (state, position, or offset) of an entire event hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and with their own offsets. A default consumer group ($Default) is automatically created for each event hub.

Big DataEvent StreamingIoTMessage IngestionReal-Time Processing

Properties

Name	Type	Description
id	string	Fully qualified resource ID for the resource.
name	string	The name of the consumer group.
type	string	The type of the resource.
location	string	The geo-location where the resource lives.
properties	object	Consumer group properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://schema.azure.com/eventhub/2024-01-01/consumer-group.json",
  "title": "Azure Event Hubs Consumer Group",
  "description": "A consumer group is a view (state, position, or offset) of an entire event hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and with their own offsets. A default consumer group ($Default) is automatically created for each event hub.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Fully qualified resource ID for the resource.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the consumer group.",
      "minLength": 1,
      "maxLength": 50,
      "readOnly": true
    },
    "type": {
      "type": "string",
      "description": "The type of the resource.",
      "const": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups",
      "readOnly": true
    },
    "location": {
      "type": "string",
      "description": "The geo-location where the resource lives.",
      "readOnly": true
    },
    "properties": {
      "type": "object",
      "description": "Consumer group properties.",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "Exact time the consumer group was created.",
          "readOnly": true
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The exact time the consumer group was last updated.",
          "readOnly": true
        },
        "userMetadata": {
          "type": "string",
          "description": "User Metadata is a placeholder to store user-defined string data with maximum length 1024. It can be used to store descriptive data, such as list of teams and their contact information, or user-defined configuration settings.",
          "maxLength": 1024
        }
      }
    },
    "systemData": {
      "type": "object",
      "description": "Metadata pertaining to creation and last modification of the resource.",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdByType": {
          "type": "string",
          "enum": ["User", "Application", "ManagedIdentity", "Key"]
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "lastModifiedBy": {
          "type": "string"
        },
        "lastModifiedByType": {
          "type": "string",
          "enum": ["User", "Application", "ManagedIdentity", "Key"]
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}