次の方法で共有

SchemaRegistryClient class

  • リファレンス
パッケージ:
@azure/schema-registry

Azure Schema Registry サービスのクライアント。

コンストラクター

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Azure Schema Registry サービス用の新しいクライアントを作成します。

プロパティ

fullyQualifiedNamespace

スキーマ レジストリ サービスの完全修飾名前空間 URL。

メソッド

getSchema(string, GetSchemaOptions)

ID で既存のスキーマを取得します。 スキーマが見つからない場合は、状態コード 404 を持つ RestError がスローされ、次のようにキャッチされる可能性があります。

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

バージョン別に既存のスキーマを取得します。 スキーマが見つからない場合は、状態コード 404 を持つ RestError がスローされ、次のようにキャッチされる可能性があります。

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

名前、グループ、型、定義が一致する既存のスキーマの ID を取得します。
registerSchema(SchemaDescription, RegisterSchemaOptions)

新しいスキーマを登録し、その ID を返します。

指定した名前のスキーマが指定したグループに存在しない場合は、バージョン 1 でスキーマが作成されます。 指定した名前のスキーマが指定したグループに既に存在する場合、スキーマは最新バージョン + 1 で作成されます。

コンストラクターの詳細

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Azure Schema Registry サービス用の新しいクライアントを作成します。

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)

ID で既存のスキーマを取得します。 スキーマが見つからない場合は、状態コード 404 を持つ RestError がスローされ、次のようにキャッチされる可能性があります。

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

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

パラメーター

schemaId

string

一意のスキーマ ID。

options
GetSchemaOptions

戻り値

Promise<Schema>

指定された ID を持つスキーマ。

getSchema(string, string, number, GetSchemaOptions)

バージョン別に既存のスキーマを取得します。 スキーマが見つからない場合は、状態コード 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>

パラメーター

name

string

groupName

string

version

number

options
GetSchemaOptions

戻り値

Promise<Schema>

指定された ID を持つスキーマ。

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

名前、グループ、型、定義が一致する既存のスキーマの ID を取得します。

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

パラメーター

schema
SchemaDescription

照合するスキーマ。

options
GetSchemaPropertiesOptions

戻り値

Promise<SchemaProperties>

一致したスキーマの ID。

registerSchema(SchemaDescription, RegisterSchemaOptions)

新しいスキーマを登録し、その ID を返します。

指定した名前のスキーマが指定したグループに存在しない場合は、バージョン 1 でスキーマが作成されます。 指定した名前のスキーマが指定したグループに既に存在する場合、スキーマは最新バージョン + 1 で作成されます。

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

パラメーター

schema
SchemaDescription

登録するスキーマ。

options
RegisterSchemaOptions

戻り値

Promise<SchemaProperties>

登録済みスキーマの ID。