Freigeben über

SchemaRegistryClient class

Paket:
@azure/schema-registry

Client für azure Schema Registry Service.

Konstruktoren

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Erstellt einen neuen Client für den Azure Schema Registry Service.

Eigenschaften

fullyQualifiedNamespace

Die vollqualifizierte Namespace-URL des Schemaregistrierungsdiensts.

Methoden

getSchema(string, GetSchemaOptions)

Ruft ein vorhandenes Schema nach ID ab. Wenn das Schema nicht gefunden wurde, wird ein RestError mit Statuscode 404 ausgelöst, der wie folgt abgefangen werden kann:

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

Ruft ein vorhandenes Schema nach Version ab. Wenn das Schema nicht gefunden wurde, wird ein RestError mit Statuscode 404 ausgelöst, der wie folgt abgefangen werden kann:

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

Ruft die ID eines vorhandenen Schemas mit übereinstimmendem Namen, Gruppen, Typ und Definition ab.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Registriert ein neues Schema und gibt seine ID zurück.

Wenn das Schema des angegebenen Namens in der angegebenen Gruppe nicht vorhanden ist, wird unter Version 1 ein Schema erstellt. Wenn das Schema des angegebenen Namens bereits in der angegebenen Gruppe vorhanden ist, wird das Schema mit der neuesten Version + 1 erstellt.

Details zum Konstruktor

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Erstellt einen neuen Client für den Azure Schema Registry Service.

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

Parameter

fullyQualifiedNamespace

string

Die qualifizierte Namespace-URL des Schemaregistrierungsdiensts, z. B. https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Anmeldeinformationen zum Authentifizieren von Anforderungen an den Dienst.

options
SchemaRegistryClientOptions

Optionen zum Konfigurieren von API-Anforderungen an den Dienst.

Details zur Eigenschaft

fullyQualifiedNamespace

Die vollqualifizierte Namespace-URL des Schemaregistrierungsdiensts.

fullyQualifiedNamespace: string

Eigenschaftswert

string

Details zur Methode

getSchema(string, GetSchemaOptions)

Ruft ein vorhandenes Schema nach ID ab. Wenn das Schema nicht gefunden wurde, wird ein RestError mit Statuscode 404 ausgelöst, der wie folgt abgefangen werden kann:

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

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

Parameter

schemaId

string

Eindeutige Schema-ID.

options
GetSchemaOptions

Gibt zurück

Promise<Schema>

Schema mit gegebener ID.

getSchema(string, string, number, GetSchemaOptions)

Ruft ein vorhandenes Schema nach Version ab. Wenn das Schema nicht gefunden wurde, wird ein RestError mit Statuscode 404 ausgelöst, der wie folgt abgefangen werden kann:

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

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

Parameter

name

string

groupName

string

version

number

options
GetSchemaOptions

Gibt zurück

Promise<Schema>

Schema mit gegebener ID.

Hinweise

Wenn der Client eine ältere API-Version verwendet, die das Format des Schemas nicht unterstützt, gibt das Schemaformat möglicherweise den Wert im Inhaltstypheader zurück. Aktualisieren Sie mit der neuesten API-Version auf den Client, damit es das richtige Schemaformat zurückgeben kann.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Ruft die ID eines vorhandenen Schemas mit übereinstimmendem Namen, Gruppen, Typ und Definition ab.

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

Parameter

schema
SchemaDescription

Schema, das übereinstimmen soll.

options
GetSchemaPropertiesOptions

Gibt zurück

Promise<SchemaProperties>

Die ID des übereinstimmenen Schemas.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Registriert ein neues Schema und gibt seine ID zurück.

Wenn das Schema des angegebenen Namens in der angegebenen Gruppe nicht vorhanden ist, wird unter Version 1 ein Schema erstellt. Wenn das Schema des angegebenen Namens bereits in der angegebenen Gruppe vorhanden ist, wird das Schema mit der neuesten Version + 1 erstellt.

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

Parameter

schema
SchemaDescription

Schema, das registriert werden soll.

options
RegisterSchemaOptions

Gibt zurück

Promise<SchemaProperties>

Id des registrierten Schemas.