SchemaRegistryClient class

Pacote:

@azure/schema-registry

Cliente do Serviço de Registo de Esquemas do Azure.

Construtores

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Cria um novo cliente para o serviço Azure Schema Registry.

Propriedades

fullyQualifiedNamespace

O URL do espaço de nomes completamente qualificado do serviço do Registo de Esquemas.

Métodos

getSchema(string, GetSchemaOptions)	Obtém um esquema existente por ID. Se o esquema não for encontrado, será emitido um RestError com o código de estado 404, que poderá ser capturado da seguinte forma: ... } 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 for encontrado, será emitido um RestError com o código de estado 404, que poderá ser capturado da seguinte forma: ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)	Obtém o ID de um esquema existente com o nome, grupo, tipo e definição correspondentes.
registerSchema(SchemaDescription, RegisterSchemaOptions)	Regista um novo esquema e devolve o respetivo ID. Se o esquema do nome especificado não existir no grupo especificado, será criado um esquema na versão 1. Se o esquema do nome especificado já existir no grupo especificado, o esquema é criado na versão mais recente + 1.

Detalhes do Construtor

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Cria um novo cliente para o serviço Azure Schema Registry.

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

Parâmetros

fullyQualifiedNamespace

string

O URL do espaço de nomes qualificado do serviço do Registo de Esquemas, por exemplo https://mynamespace.servicebus.windows.net.

credential

TokenCredential

Credencial para autenticar pedidos para o serviço.

options

SchemaRegistryClientOptions

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

Detalhes de Propriedade

fullyQualifiedNamespace

O URL do espaço de nomes completamente qualificado do serviço do Registo de Esquemas.

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 for encontrado, será emitido um RestError com o código de estado 404, que poderá ser capturado da seguinte forma:

...
} 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 o ID especificado.

getSchema(string, string, number, GetSchemaOptions)

Obtém um esquema existente por versão. Se o esquema não for encontrado, será emitido um RestError com o código de estado 404, que poderá ser capturado da seguinte forma:

...
} 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 o ID especificado.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

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

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

Parâmetros

schema

SchemaDescription

Esquema a corresponder.

options

GetSchemaPropertiesOptions

Devoluções

Promise<SchemaProperties>

ID do esquema correspondente.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Regista um novo esquema e devolve o respetivo ID.

Se o esquema do nome especificado não existir no grupo especificado, será criado um esquema na versão 1. Se o esquema do nome especificado já existir no grupo especificado, o esquema é criado na versão mais recente + 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 registado.