azure-schemaregistry

What it is and what it does

Azure Schema Registry is a client library for interacting with Azure's schema repository service hosted by Event Hubs. It provides two main capabilities: a SchemaRegistryClient for registering and retrieving schemas and their metadata, and a JsonSchemaEncoder for encoding and decoding message payloads that reference schemas by identifier rather than embedding full schema definitions. This reduces payload size in messaging scenarios by replacing verbose schema definitions with compact schema IDs.

The package depends on azure-core for common Azure SDK patterns, isodate for date/time handling, and typing-extensions for type hints. It supports Python 3.8 and later, and integrates with Azure Event Hubs message types (EventData) through protocol-based interoperability. Optional JSON schema validation is available via the jsonencoder extras install.

Use it for:

• Reduce Event Hubs message payload size by storing schemas centrally and referencing them by ID instead of embedding full schema definitions.
• Manage multiple versions of schemas for different data producers and consumers in a shared Azure environment.
• Validate and encode JSON payloads against registered schemas before publishing to Event Hubs or other Azure messaging services.
• Retrieve schema definitions and metadata programmatically to support schema-driven data processing pipelines.
• Build event-driven applications that need schema governance and versioning across distributed systems.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Registers, retrieves, and manages schemas in Azure Schema Registry, and encodes/decodes JSON payloads using schema identifiers to reduce message size.

Yes. This is a production-stable package (Development Status 5) with active maintenance, no known vulnerabilities, and low install friction. Install it if you are building applications on Azure that use Event Hubs and need schema management, payload size optimization, or schema-driven encoding. The MIT license poses no restrictions. If you do not use Azure Schema Registry or Event Hubs, this package is not applicable.

Install

azure-schemaregistry on PyPI

pip install azure-schemaregistry

uv add azure-schemaregistry

poetry add azure-schemaregistry

Installing azure-schemaregistry

Before you install

Low friction installation with three lightweight runtime dependencies. Actively maintained as of 2024-09-18 with recent commits; part of the Azure SDK ecosystem with stable production status.

License in practice

MIT License permits commercial and private use with minimal restrictions; you may use, modify, and distribute this package freely provided you include the license notice.

Quickstart

pip install azure-schemaregistry

from azure.schemaregistry import SchemaRegistryClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
fully_qualified_namespace = '<your-namespace>.servicebus.windows.net'
client = SchemaRegistryClient(fully_qualified_namespace, credential)

Requires an Azure subscription and an Azure Schema Registry instance; you must provide Azure Active Directory credentials and the fully qualified namespace of your Schema Registry service.

Verify before relying

• Performance characteristics and latency for schema lookups and encoding/decoding operations under typical load.
• Whether the optional jsonencoder extras (for jsonschema validation) are recommended for production use or only for development.
• Compatibility details with specific versions of azure-eventhub beyond the stated >=5.9.0 requirement.

Package facts

Evidence: azure_schemaregistry-1.3.0-py3-none-any.whl

Keywords: azure, azure sdk

Tags

More Internet packages