SchemaRegistryClient class

为 Azure 架构注册表服务创建新的客户端。

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

参数

架构注册表服务完全限定的命名空间 URL。

fullyQualifiedNamespace: string

属性值

按 ID 获取现有架构。 如果未找到架构，将引发状态代码为 404 的 RestError，可能会捕获如下所示：

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

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

参数

返回

具有给定 ID 的架构。

按版本获取现有架构。 如果未找到架构，将引发状态代码为 404 的 RestError，可能会捕获如下所示：

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

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

参数

返回

具有给定 ID 的架构。

注解

如果客户端使用不支持架构格式的较旧 API 版本，架构格式可能会返回内容类型标头中的值。 请使用最新的 API 版本升级到客户端，以便它可以返回正确的架构格式。

获取具有匹配名称、组、类型和定义的现有架构的 ID。

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

参数

返回

匹配架构的 ID。

注册新架构并返回其 ID。

如果指定名称的架构在指定组中不存在，则会在版本 1 中创建架构。 如果指定名称的架构已存在于指定组中，则会在最新版本 + 1 中创建架构。

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

参数

返回

已注册架构的 ID。