SchemaRegistryClient class

Пакет:
@azure/schema-registry

Клиент службы реестра схем Azure.

Конструкторы

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Создает новый клиент для службы реестра схем Azure.

Свойства

fullyQualifiedNamespace

Полный URL-адрес пространства имен службы реестра схем.

Методы

getSchema(string, GetSchemaOptions)

Возвращает существующую схему по идентификатору. Если схема не найдена, возникает ошибка RestError с кодом состояния 404, которая может быть поймана следующим образом:

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

Возвращает существующую схему по версии. Если схема не найдена, возникает ошибка RestError с кодом состояния 404, которая может быть поймана следующим образом:

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

Возвращает идентификатор существующей схемы с соответствующим именем, группой, типом и определением.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Регистрирует новую схему и возвращает его идентификатор.

Если схема указанного имени не существует в указанной группе, схема создается в версии 1. Если схема указанного имени уже существует в указанной группе, схема создается в последней версии + 1.

Сведения о конструкторе

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Создает новый клиент для службы реестра схем Azure.

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

Параметры

fullyQualifiedNamespace

string

URL-адрес пространства имен службы реестра схем, например https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Учетные данные для проверки подлинности запросов к службе.

options
SchemaRegistryClientOptions

Параметры настройки запросов API к службе.

Сведения о свойстве

fullyQualifiedNamespace

Полный URL-адрес пространства имен службы реестра схем.

fullyQualifiedNamespace: string

Значение свойства

string

Сведения о методе

getSchema(string, GetSchemaOptions)

Возвращает существующую схему по идентификатору. Если схема не найдена, возникает ошибка RestError с кодом состояния 404, которая может быть поймана следующим образом:

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

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

Параметры

schemaId

string

Уникальный идентификатор схемы.

options
GetSchemaOptions

Возвращаемое значение

Promise<Schema>

Схема с заданным идентификатором.

getSchema(string, string, number, GetSchemaOptions)

Возвращает существующую схему по версии. Если схема не найдена, возникает ошибка RestError с кодом состояния 404, которая может быть поймана следующим образом:

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

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

Параметры

name

string

groupName

string

version

number

options
GetSchemaOptions

Возвращаемое значение

Promise<Schema>

Схема с заданным идентификатором.

Комментарии

Если клиент использует старую версию API, которая не поддерживает формат схемы, формат схемы может возвращать значение в заголовке типа контента. Обновите клиент с помощью последней версии API, чтобы он смог вернуть правильный формат схемы.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Возвращает идентификатор существующей схемы с соответствующим именем, группой, типом и определением.

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

Параметры

schema
SchemaDescription

Схема для сопоставления.

options
GetSchemaPropertiesOptions

Возвращаемое значение

Promise<SchemaProperties>

Идентификатор сопоставленной схемы.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Регистрирует новую схему и возвращает его идентификатор.

Если схема указанного имени не существует в указанной группе, схема создается в версии 1. Если схема указанного имени уже существует в указанной группе, схема создается в последней версии + 1.

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

Параметры

schema
SchemaDescription

Схема для регистрации.

options
RegisterSchemaOptions

Возвращаемое значение

Promise<SchemaProperties>

Идентификатор зарегистрированной схемы.