Sdílet prostřednictvím

SchemaRegistryClient class

  • Reference
Balíček:
@azure/schema-registry

Klient služby Azure Schema Registry.

Konstruktory

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Vytvoří nového klienta pro službu Azure Schema Registry.

Vlastnosti

fullyQualifiedNamespace

Plně kvalifikovaná adresa URL oboru názvů služby Registru schémat.

Metody

getSchema(string, GetSchemaOptions)

Získá existující schéma podle ID. Pokud se schéma nenašlo, vyvolá se chyba RestError se stavovým kódem 404, která může být zachycena následujícím způsobem:

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

Získá existující schéma podle verze. Pokud se schéma nenašlo, vyvolá se chyba RestError se stavovým kódem 404, která může být zachycena následujícím způsobem:

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

Získá ID existujícího schématu s odpovídajícím názvem, skupinou, typem a definicí.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Zaregistruje nové schéma a vrátí jeho ID.

Pokud schéma zadaného názvu v zadané skupině neexistuje, vytvoří se schéma ve verzi 1. Pokud schéma zadaného názvu již v zadané skupině existuje, vytvoří se schéma v nejnovější verzi + 1.

Podrobnosti konstruktoru

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Vytvoří nového klienta pro službu Azure Schema Registry.

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

Parametry

fullyQualifiedNamespace

string

Kvalifikovaná adresa URL oboru názvů služby Registru schémat, například https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Přihlašovací údaje k ověření požadavků na službu.

options
SchemaRegistryClientOptions

Možnosti konfigurace požadavků rozhraní API na službu

Podrobnosti vlastnosti

fullyQualifiedNamespace

Plně kvalifikovaná adresa URL oboru názvů služby Registru schémat.

fullyQualifiedNamespace: string

Hodnota vlastnosti

string

Podrobnosti metody

getSchema(string, GetSchemaOptions)

Získá existující schéma podle ID. Pokud se schéma nenašlo, vyvolá se chyba RestError se stavovým kódem 404, která může být zachycena následujícím způsobem:

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

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

Parametry

schemaId

string

Jedinečné ID schématu

options
GetSchemaOptions

Návraty

Promise<Schema>

Schéma s daným ID

getSchema(string, string, number, GetSchemaOptions)

Získá existující schéma podle verze. Pokud se schéma nenašlo, vyvolá se chyba RestError se stavovým kódem 404, která může být zachycena následujícím způsobem:

...
} 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

Návraty

Promise<Schema>

Schéma s daným ID

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Získá ID existujícího schématu s odpovídajícím názvem, skupinou, typem a definicí.

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

Parametry

schema
SchemaDescription

Schéma, které se má shodovat.

options
GetSchemaPropertiesOptions

Návraty

Promise<SchemaProperties>

ID odpovídajícího schématu.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Zaregistruje nové schéma a vrátí jeho ID.

Pokud schéma zadaného názvu v zadané skupině neexistuje, vytvoří se schéma ve verzi 1. Pokud schéma zadaného názvu již v zadané skupině existuje, vytvoří se schéma v nejnovější verzi + 1.

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

Parametry

schema
SchemaDescription

Schéma, které se má zaregistrovat.

options
RegisterSchemaOptions

Návraty

Promise<SchemaProperties>

ID registrovaného schématu.