SchemaRegistryClient class

Pakiet:

@azure/schema-registry

Klient usługi Azure Schema Registry.

Konstruktory

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Tworzy nowego klienta dla usługi Azure Schema Registry.

Właściwości

fullyQualifiedNamespace

Adres URL w pełni kwalifikowanej przestrzeni nazw usługi Schema Registry.

Metody

getSchema(string, GetSchemaOptions)	Pobiera istniejący schemat według identyfikatora. Jeśli schemat nie został znaleziony, zostanie zgłoszony błąd RESTError z kodem stanu 404, co może zostać przechwycone w następujący sposób: ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchema(string, string, number, GetSchemaOptions)	Pobiera istniejący schemat według wersji. Jeśli schemat nie został znaleziony, zostanie zgłoszony błąd RESTError z kodem stanu 404, co może zostać przechwycone w następujący sposób: ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)	Pobiera identyfikator istniejącego schematu z pasującą nazwą, grupą, typem i definicją.
registerSchema(SchemaDescription, RegisterSchemaOptions)	Rejestruje nowy schemat i zwraca jego identyfikator. Jeśli schemat określonej nazwy nie istnieje w określonej grupie, schemat zostanie utworzony w wersji 1. Jeśli schemat określonej nazwy istnieje już w określonej grupie, schemat jest tworzony w najnowszej wersji + 1.

Szczegóły konstruktora

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Tworzy nowego klienta dla usługi Azure Schema Registry.

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

Parametry

fullyQualifiedNamespace

string

Adres URL kwalifikowanej przestrzeni nazw usługi Rejestru schematów, na przykład https://mynamespace.servicebus.windows.net.

credential

TokenCredential

Poświadczenia do uwierzytelniania żądań w usłudze.

options

SchemaRegistryClientOptions

Opcje konfigurowania żądań interfejsu API do usługi.

Szczegóły właściwości

fullyQualifiedNamespace

Adres URL w pełni kwalifikowanej przestrzeni nazw usługi Schema Registry.

fullyQualifiedNamespace: string

Wartość właściwości

string

Szczegóły metody

getSchema(string, GetSchemaOptions)

Pobiera istniejący schemat według identyfikatora. Jeśli schemat nie został znaleziony, zostanie zgłoszony błąd RESTError z kodem stanu 404, co może zostać przechwycone w następujący sposób:

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

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

Parametry

schemaId

string

Unikatowy identyfikator schematu.

options

GetSchemaOptions

Zwraca

Promise<Schema>

Schemat o podanym identyfikatorze.

getSchema(string, string, number, GetSchemaOptions)

Pobiera istniejący schemat według wersji. Jeśli schemat nie został znaleziony, zostanie zgłoszony błąd RESTError z kodem stanu 404, co może zostać przechwycone w następujący sposób:

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

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

Parametry

name

string

groupName

string

version

number

options

GetSchemaOptions

Zwraca

Promise<Schema>

Schemat o podanym identyfikatorze.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Pobiera identyfikator istniejącego schematu z pasującą nazwą, grupą, typem i definicją.

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

Parametry

schema

SchemaDescription

Schemat do dopasowania.

options

GetSchemaPropertiesOptions

Zwraca

Promise<SchemaProperties>

Identyfikator dopasowanego schematu.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Rejestruje nowy schemat i zwraca jego identyfikator.

Jeśli schemat określonej nazwy nie istnieje w określonej grupie, schemat zostanie utworzony w wersji 1. Jeśli schemat określonej nazwy istnieje już w określonej grupie, schemat jest tworzony w najnowszej wersji + 1.

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

Parametry

schema

SchemaDescription

Schemat do zarejestrowania.

options

RegisterSchemaOptions

Zwraca

Promise<SchemaProperties>

Identyfikator zarejestrowanego schematu.