Compartilhar via

SchemaRegistryClient class

  • Referência
Pacote:
@azure/schema-registry

Cliente para o serviço registro de esquema do Azure.

Construtores

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Cria um novo cliente para o serviço registro de esquema do Azure.

Propriedades

fullyQualifiedNamespace

A URL do namespace totalmente qualificado do serviço registro de esquema.

Métodos

getSchema(string, GetSchemaOptions)

Obtém um esquema existente por ID. Se o esquema não tiver sido encontrado, um RestError com o código de status 404 será lançado, o que pode ser capturado da seguinte maneira:

...
} catch (e) {
if (typeof e === "object" && e.statusCode === 404) {
...;
}
throw e;
}
getSchema(string, string, number, GetSchemaOptions)

Obtém um esquema existente por versão. Se o esquema não tiver sido encontrado, um RestError com o código de status 404 será lançado, o que pode ser capturado da seguinte maneira:

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

Obtém a ID de um esquema existente com nome, grupo, tipo e definição correspondentes.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Registra um novo esquema e retorna sua ID.

Se o esquema de nome especificado não existir no grupo especificado, um esquema será criado na versão 1. Se o esquema de nome especificado já existir no grupo especificado, o esquema será criado na versão mais recente + 1.

Detalhes do construtor

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Cria um novo cliente para o serviço registro de esquema do Azure.

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

Parâmetros

fullyQualifiedNamespace

string

A URL do namespace qualificado do serviço registro de esquema, por exemplo https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Credencial para autenticar solicitações para o serviço.

options
SchemaRegistryClientOptions

Opções para configurar solicitações de API para o serviço.

Detalhes da propriedade

fullyQualifiedNamespace

A URL do namespace totalmente qualificado do serviço registro de esquema.

fullyQualifiedNamespace: string

Valor da propriedade

string

Detalhes do método

getSchema(string, GetSchemaOptions)

Obtém um esquema existente por ID. Se o esquema não tiver sido encontrado, um RestError com o código de status 404 será lançado, o que pode ser capturado da seguinte maneira:

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

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

Parâmetros

schemaId

string

ID de esquema exclusiva.

options
GetSchemaOptions

Retornos

Promise<Schema>

Esquema com determinada ID.

getSchema(string, string, number, GetSchemaOptions)

Obtém um esquema existente por versão. Se o esquema não tiver sido encontrado, um RestError com o código de status 404 será lançado, o que pode ser capturado da seguinte maneira:

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

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

Parâmetros

name

string

groupName

string

version

number

options
GetSchemaOptions

Retornos

Promise<Schema>

Esquema com determinada ID.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Obtém a ID de um esquema existente com nome, grupo, tipo e definição correspondentes.

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

Parâmetros

schema
SchemaDescription

Esquema a ser correspondido.

options
GetSchemaPropertiesOptions

Retornos

Promise<SchemaProperties>

ID do esquema correspondente.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Registra um novo esquema e retorna sua ID.

Se o esquema de nome especificado não existir no grupo especificado, um esquema será criado na versão 1. Se o esquema de nome especificado já existir no grupo especificado, o esquema será criado na versão mais recente + 1.

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

Parâmetros

schema
SchemaDescription

Esquema a ser registrado.

options
RegisterSchemaOptions

Retornos

Promise<SchemaProperties>

ID do esquema registrado.