Share via

Schema Registry REST API documentation

The methods described in this section allow you to create, read, update, and delete resources in Schema Registry.

Security definition

Schema Registry accesses resources via Microsoft Entra ID. Here are the steps to create an app registration in Microsoft Entra ID with proper permissions to use REST API:

  1. Register your app with Microsoft Entra ID.
  2. Once app is registered, create a client secret for the app, and take note of the tenant ID the app is under, the client ID, and the client secret.
  3. Navigate to the Event Hubs namespace in the Azure portal, select Access control (IAM) on the left menu. Add your app to one of the following roles: SchemaRegistry Administrator or Event Hubs Owner (the latter supersedes the former). For step-by-step instruction, see How to add app roles to your Entra app

Acquire bearer token for requests

A bearer token is required to authenticate with Schema Registry and access resources. It requires the tenant ID, client ID, and client secret of the app registration from the previous step.

  1. Follow steps from the article: Get Microsoft Entra ID token (No need to follow the last step, just get the token). Client doesn't have to be Postman; you can use any REST client to make the token request)
  2. When filling out the form for the token request, use https://eventhubs.azure.net/ as the value for the resource key.
  3. Grab the Bearer token from the access_token field in the response

REST Call Definitions

Set the API version to 2023-07-01 and the api-version query parameter to 2023-07-01 (?api-version=2023-07-01).

Tasks

You can perform the following Schema Registry operations:

  • Last updated on