SchemaRegistryClient class

Pakket:

@azure/schema-registry

Client voor Azure Schema Registry-service.

Constructors

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Hiermee maakt u een nieuwe client voor de Azure Schema Registry-service.

Eigenschappen

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte-URL van de Schema Registry-service.

Methoden

getSchema(string, GetSchemaOptions)	Hiermee haalt u een bestaand schema op basis van id op. Als het schema niet is gevonden, wordt er een RestError met statuscode 404 gegenereerd. Dit kan als volgt worden opgevangen: ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchema(string, string, number, GetSchemaOptions)	Hiermee haalt u een bestaand schema op versie op. Als het schema niet is gevonden, wordt er een RestError met statuscode 404 gegenereerd. Dit kan als volgt worden opgevangen: ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)	Hiermee haalt u de id van een bestaand schema op met overeenkomende naam, groep, type en definitie.
registerSchema(SchemaDescription, RegisterSchemaOptions)	Registreert een nieuw schema en retourneert de id. Als het schema van de opgegeven naam niet bestaat in de opgegeven groep, wordt er een schema gemaakt op versie 1. Als het schema van de opgegeven naam al bestaat in de opgegeven groep, wordt het schema gemaakt in de nieuwste versie + 1.

Constructordetails

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Hiermee maakt u een nieuwe client voor de Azure Schema Registry-service.

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

Parameters

fullyQualifiedNamespace

string

De url van de gekwalificeerde naamruimte van de Schema Registry-service, bijvoorbeeld https://mynamespace.servicebus.windows.net.

credential

TokenCredential

Referenties voor het verifiëren van aanvragen voor de service.

options

SchemaRegistryClientOptions

Opties voor het configureren van API-aanvragen voor de service.

Eigenschapdetails

fullyQualifiedNamespace

De volledig gekwalificeerde naamruimte-URL van de Schema Registry-service.

fullyQualifiedNamespace: string

Waarde van eigenschap

string

Methodedetails

getSchema(string, GetSchemaOptions)

Hiermee haalt u een bestaand schema op basis van id op. Als het schema niet is gevonden, wordt er een RestError met statuscode 404 gegenereerd. Dit kan als volgt worden opgevangen:

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

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

Parameters

schemaId

string

Unieke schema-id.

options

GetSchemaOptions

Retouren

Promise<Schema>

Schema met opgegeven id.

getSchema(string, string, number, GetSchemaOptions)

Hiermee haalt u een bestaand schema op versie op. Als het schema niet is gevonden, wordt er een RestError met statuscode 404 gegenereerd. Dit kan als volgt worden opgevangen:

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

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

Parameters

name

string

groupName

string

version

number

options

GetSchemaOptions

Retouren

Promise<Schema>

Schema met opgegeven id.

Opmerkingen

Als de client een oudere API-versie gebruikt die de indeling van het schema niet ondersteunt, kan de schema-indeling de waarde in de header van het inhoudstype retourneren. Voer een upgrade uit naar de client met behulp van de nieuwste API-versie, zodat deze de juiste schema-indeling kan retourneren.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Hiermee haalt u de id van een bestaand schema op met overeenkomende naam, groep, type en definitie.

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

Parameters

schema

SchemaDescription

Schema dat overeenkomt.

options

GetSchemaPropertiesOptions

Retouren

Promise<SchemaProperties>

Overeenkomende schema-id.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Registreert een nieuw schema en retourneert de id.

Als het schema van de opgegeven naam niet bestaat in de opgegeven groep, wordt er een schema gemaakt op versie 1. Als het schema van de opgegeven naam al bestaat in de opgegeven groep, wordt het schema gemaakt in de nieuwste versie + 1.

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

Parameters

schema

SchemaDescription

Schema om te registreren.

options

RegisterSchemaOptions

Retouren

Promise<SchemaProperties>

De id van het geregistreerde schema.