Skip to main content

Introduction

The EventCatalog Azure Schema Registry plugin allows you to import schemas from Azure Schema Registry into EventCatalog and keep them in sync alongside your documentation.

info

What is Azure Schema Registry?: A schema registry for Azure Event Hubs. Use this to store and manage your schemas for event-driven applications. You can read more about it on the Microsoft Learn website.

Why use EventCatalog with Azure Schema Registry?​

The EventCatalog Azure Schema Registry plugin can provide you with many features, including:

  • Keep your schemas in sync with your architecture documentation
  • Automatic versioning; as your schemas change they are versioned in EventCatalog alongside your documentation
  • Understand how your schemas have evolved over time with the Schema diff explorer with the Schema Explorer
  • Add meaning (markdown) to your schemas. Provide business context to your schemas and add value
  • Quickly find who is producing or consuming your schemas
  • Visualize your Azure Event Hubs architecture with the EventCatalog Visualizer
  • Download and view schemas in EventCatalog (Avro, JSON Schema) or through the Schema API
  • Use EventCatalog MCP server to get schemas for your LLMs

How it works​

  1. Install the Azure Schema Registry plugin
  2. Configure the plugin (schemas, services, domains, message types)
  3. Get an Azure access token using Azure CLI: az account get-access-token --resource https://eventhubs.azure.net
  4. Set the token as an environment variable: AZURE_SCHEMA_REGISTRY_TOKEN
  5. Run the plugin to import your schemas into EventCatalog
  6. View and deploy your catalog

What are generators?

EventCatalog supports generators. These are scripts or plugins that can be run to integrate with any external API, system or specification files. EventCatalog also provides an SDK to give developers easier access to their catalogs through custom scripts or generators.

The EventCatalog Azure Schema Registry plugin is a generator. It will import your schemas from your Azure Schema Registry into EventCatalog.

Authentication​

The plugin uses Azure's REST API with Bearer token authentication. You need to provide an Azure access token via the AZURE_SCHEMA_REGISTRY_TOKEN environment variable.

Why use the REST API vs the Azure SDK?

The schema registry SDK is limiting and doesn't allow you to fetch all schemas from a registry. It also doesn't allow you to fetch schemas from multiple registries in one configuration.

We use the REST API because it is simpler and more flexible. It doesn't require you to install any Azure SDK packages and works seamlessly across different environments without requiring any code changes.

Commercial and License​

This plugin requires a license key to be used.

You can get a 14 day trial license key to try the plugin out by going to EventCatalog Cloud.

After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization based on where you are in your governance and documentation journey.

See pricing for more information.

Have any questions? You can email us at hello@eventcatalog.dev.

License FAQ​

What is the license key for?​

The license key is required to use the Azure Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.

How do I get a license key?​

You can obtain a license key by visiting EventCatalog Cloud. New users can start with a 14-day free trial.

Terms​

  • Trial Period: 14 days free trial no credit card required
  • Support: Discord community support (extra for priority support)

After your trial period ends, you can purchase a full license through EventCatalog Cloud to continue using the plugin.