SchemaRegistryClient class

Paquet:

@azure/schema-registry

Client pour le service Azure Schema Registry.

Constructeurs

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Crée un client pour le service Azure Schema Registry.

Propriétés

fullyQualifiedNamespace

URL de l’espace de noms complet du service Schema Registry.

Méthodes

getSchema(string, GetSchemaOptions)	Obtient un schéma existant par ID. Si le schéma est introuvable, une erreur RestError avec le code d’état 404 est levée, qui peut être interceptée comme suit : ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchema(string, string, number, GetSchemaOptions)	Obtient un schéma existant par version. Si le schéma est introuvable, une erreur RestError avec le code d’état 404 est levée, qui peut être interceptée comme suit : ... } catch (e) { if (typeof e === "object" && e.statusCode === 404) { ...; } throw e; }
getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)	Obtient l’ID d’un schéma existant avec le nom, le groupe, le type et la définition correspondants.
registerSchema(SchemaDescription, RegisterSchemaOptions)	Inscrit un nouveau schéma et retourne son ID. Si le schéma du nom spécifié n’existe pas dans le groupe spécifié, un schéma est créé à la version 1. Si le schéma du nom spécifié existe déjà dans le groupe spécifié, le schéma est créé à la dernière version + 1.

Détails du constructeur

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Crée un client pour le service Azure Schema Registry.

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

Paramètres

fullyQualifiedNamespace

string

URL de l’espace de noms qualifié du service De registre de schémas, par exemple https://mynamespace.servicebus.windows.net.

credential

TokenCredential

Informations d’identification pour authentifier les demandes adressées au service.

options

SchemaRegistryClientOptions

Options pour configurer les demandes d’API adressées au service.

Détails de la propriété

fullyQualifiedNamespace

URL de l’espace de noms complet du service Schema Registry.

fullyQualifiedNamespace: string

Valeur de propriété

string

Détails de la méthode

getSchema(string, GetSchemaOptions)

Obtient un schéma existant par ID. Si le schéma est introuvable, une erreur RestError avec le code d’état 404 est levée, qui peut être interceptée comme suit :

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

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

Paramètres

schemaId

string

ID de schéma unique.

options

GetSchemaOptions

Retours

Promise<Schema>

Schéma avec l’ID donné.

getSchema(string, string, number, GetSchemaOptions)

Obtient un schéma existant par version. Si le schéma est introuvable, une erreur RestError avec le code d’état 404 est levée, qui peut être interceptée comme suit :

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

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

Paramètres

name

string

groupName

string

version

number

options

GetSchemaOptions

Retours

Promise<Schema>

Schéma avec l’ID donné.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Obtient l’ID d’un schéma existant avec le nom, le groupe, le type et la définition correspondants.

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

Paramètres

schema

SchemaDescription

Schéma à mettre en correspondance.

options

GetSchemaPropertiesOptions

Retours

Promise<SchemaProperties>

ID du schéma correspondant.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Inscrit un nouveau schéma et retourne son ID.

Si le schéma du nom spécifié n’existe pas dans le groupe spécifié, un schéma est créé à la version 1. Si le schéma du nom spécifié existe déjà dans le groupe spécifié, le schéma est créé à la dernière version + 1.

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

Paramètres

schema

SchemaDescription

Schéma à inscrire.

options

RegisterSchemaOptions

Retours

Promise<SchemaProperties>

ID du schéma inscrit.