Azure Event Hubs · Schema

Azure Event Hubs Schema Group

A schema group is a logical grouping of schemas within the Event Hubs Schema Registry. Schema groups define the serialization type (e.g., Avro) and compatibility mode (e.g., Backward, Forward) for schemas registered within the group. The Schema Registry enables schema-driven event serialization and deserialization for Event Hubs producers and consumers.

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 schema group.
type	string	The type of the resource.
properties	object	Schema 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/schema-group.json",
  "title": "Azure Event Hubs Schema Group",
  "description": "A schema group is a logical grouping of schemas within the Event Hubs Schema Registry. Schema groups define the serialization type (e.g., Avro) and compatibility mode (e.g., Backward, Forward) for schemas registered within the group. The Schema Registry enables schema-driven event serialization and deserialization for Event Hubs producers and consumers.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Fully qualified resource ID for the resource.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the schema group.",
      "minLength": 1,
      "maxLength": 256,
      "readOnly": true
    },
    "type": {
      "type": "string",
      "description": "The type of the resource.",
      "const": "Microsoft.EventHub/Namespaces/SchemaGroups",
      "readOnly": true
    },
    "properties": {
      "type": "object",
      "description": "Schema group properties.",
      "properties": {
        "updatedAtUtc": {
          "type": "string",
          "format": "date-time",
          "description": "Exact time the Schema Group was updated.",
          "readOnly": true
        },
        "createdAtUtc": {
          "type": "string",
          "format": "date-time",
          "description": "Exact time the Schema Group was created.",
          "readOnly": true
        },
        "eTag": {
          "type": "string",
          "format": "uuid",
          "description": "The ETag value.",
          "readOnly": true
        },
        "groupProperties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Dictionary object for SchemaGroup group properties."
        },
        "schemaCompatibility": {
          "type": "string",
          "description": "Schema compatibility setting that determines what changes are allowed when registering new schema versions.",
          "enum": ["None", "Backward", "Forward"]
        },
        "schemaType": {
          "type": "string",
          "description": "Schema serialization type used by schemas in this group.",
          "enum": ["Unknown", "Avro"]
        }
      }
    },
    "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"
        }
      }
    }
  }
}