SchemaRegistryClient class

Creates a new client for Azure Schema Registry service.

new SchemaRegistryClient(fullyQualifiedNamespace: string, credential: TokenCredential, options?: SchemaRegistryClientOptions)

Parameters

The Schema Registry service fully qualified namespace URL.

fullyQualifiedNamespace: string

Property Value

Gets an existing schema by ID. If the schema was not found, a RestError with status code 404 will be thrown, which could be caught as follows:

...
} catch (e) {
if (typeof e === "object" && e.statusCode === 404) {
...;
}
throw e;
}

function getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema>

Parameters

Returns

Schema with given ID.

Gets an existing schema by version. If the schema was not found, a RestError with status code 404 will be thrown, which could be caught as follows:

...
} catch (e) {
if (typeof e === "object" && e.statusCode === 404) {
...;
}
throw e;
}

function getSchema(name: string, groupName: string, version: number, options?: GetSchemaOptions): Promise<Schema>

Parameters

Returns

Schema with given ID.

Remarks

If the client uses an older API version that does not support the format of the schema, the schema format may return the value in the content type header. Please upgrade to the client using the latest API version so that it can return the correct schema format.

Gets the ID of an existing schema with matching name, group, type, and definition.

function getSchemaProperties(schema: SchemaDescription, options?: GetSchemaPropertiesOptions): Promise<SchemaProperties>

Parameters

Returns

Matched schema's ID.

Registers a new schema and returns its ID.

If schema of specified name does not exist in the specified group, a schema is created at version 1. If schema of specified name exists already in specified group, schema is created at latest version + 1.

function registerSchema(schema: SchemaDescription, options?: RegisterSchemaOptions): Promise<SchemaProperties>

Parameters

Returns

Registered schema's ID.