SchemaRegistryClient class

Pacote:

@azure/schema-registry

Cliente para o serviço de Registo 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 de namespace totalmente qualificada do serviço Registro de Esquema.

Métodos

getSchema(string, GetSchemaOptions)	Obtém um esquema existente por ID. Se o esquema não foi encontrado, um RestError com o código de status 404 será lançado, 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 foi encontrado, um RestError com o código de status 404 será lançado, 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 do nome especificado já existir no grupo especificado, o esquema será criado na última versão + 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 de namespace qualificada 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 de Propriedade

fullyQualifiedNamespace

A URL de namespace totalmente qualificada do serviço Registro de Esquema.

fullyQualifiedNamespace: string

Valor de Propriedade

string

Detalhes de Método

getSchema(string, GetSchemaOptions)

Obtém um esquema existente por ID. Se o esquema não foi encontrado, um RestError com o código de status 404 será lançado, 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 exclusivo.

options

GetSchemaOptions

Devoluções

Promise<Schema>

Esquema com ID fornecido.

getSchema(string, string, number, GetSchemaOptions)

Obtém um esquema existente por versão. Se o esquema não foi encontrado, um RestError com o código de status 404 será lançado, 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

Devoluções

Promise<Schema>

Esquema com ID fornecido.

Observações

Se o cliente usa uma versão mais antiga da API que não suporta o formato do esquema, o formato do esquema pode retornar o valor no cabeçalho do tipo de conteúdo. Atualize para o cliente usando a versão mais recente da API para que ele possa retornar o formato de esquema correto.

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

Devoluções

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 do nome especificado já existir no grupo especificado, o esquema será criado na última versão + 1.

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

Parâmetros

schema

SchemaDescription

Esquema a registar.

options

RegisterSchemaOptions

Devoluções

Promise<SchemaProperties>

ID do esquema registrado.