Class SchemaRegistryClient

Package version

Client for Azure Schema Registry service.

Hierarchy

SchemaRegistryClient

Implements

SchemaRegistry

Index

Constructors

constructor

Properties

fullyQualifiedNamespace

Methods

Constructors

constructor

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

- Defined in schemaRegistryClient.ts:34
Creates a new client for Azure Schema Registry service.

Parameters
- fullyQualifiedNamespace: string
  
  The Schema Registry service qualified namespace URL, for example https://mynamespace.servicebus.windows.net.
- credential: TokenCredential
  
  Credential to authenticate requests to the service.
- Default value options: SchemaRegistryClientOptions = {}
  
  Options to configure API requests to the service.
Returns SchemaRegistryClient

Properties

fullyQualifiedNamespace

fullyQualifiedNamespace: string

The Schema Registry service fully qualified namespace URL.

Methods

getSchema

getSchema(id: string, options?: GetSchemaOptions): Promise<Schema | undefined>

Implementation of SchemaRegistry.getSchema
- Defined in schemaRegistryClient.ts:118
Gets an existing schema by ID.

Parameters
- id: string
  
  Unique schema ID.
- Optional options: GetSchemaOptions
Returns Promise<Schema | undefined>

Schema with given ID or undefined if no schema was found with the given ID.

getSchemaProperties

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

Implementation of SchemaRegistry.getSchemaProperties
- Defined in schemaRegistryClient.ts:95
Gets the ID of an existing schema with matching name, group, type, and definition.

Parameters
- schema: SchemaDescription
  
  Schema to match.
- Optional options: GetSchemaPropertiesOptions
Returns Promise<SchemaProperties | undefined>

Matched schema's ID or undefined if no matching schema was found.

registerSchema

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

Implementation of SchemaRegistry.registerSchema
- Defined in schemaRegistryClient.ts:79
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.

Parameters
- schema: SchemaDescription
  
  Schema to register.
- Optional options: RegisterSchemaOptions
Returns Promise<SchemaProperties>

Registered schema's ID.

Generated using TypeDoc