SchemaRegistryClient class

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

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

パラメーター

Schema Registry サービスの完全修飾名前空間 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。