Bagikan melalui

SchemaRegistryClient class

Paket:
@azure/schema-registry

Klien untuk layanan Azure Schema Registry.

Konstruktor

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Membuat klien baru untuk layanan Azure Schema Registry.

Properti

fullyQualifiedNamespace

URL namespace layanan Schema Registry yang sepenuhnya memenuhi syarat.

Metode

getSchema(string, GetSchemaOptions)

Mendapatkan skema yang ada berdasarkan ID. Jika skema tidak ditemukan, RestError dengan kode status 404 akan dilemparkan, yang dapat ditangkap sebagai berikut:

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

Mendapatkan skema yang ada menurut versi. Jika skema tidak ditemukan, RestError dengan kode status 404 akan dilemparkan, yang dapat ditangkap sebagai berikut:

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

Mendapatkan ID skema yang ada dengan nama, grup, jenis, dan definisi yang cocok.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Mendaftarkan skema baru dan mengembalikan ID-nya.

Jika skema nama yang ditentukan tidak ada dalam grup yang ditentukan, skema dibuat pada versi 1. Jika skema nama yang ditentukan sudah ada dalam grup yang ditentukan, skema dibuat pada versi terbaru + 1.

Detail Konstruktor

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Membuat klien baru untuk layanan Azure Schema Registry.

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

Parameter

fullyQualifiedNamespace

string

URL namespace layanan Schema Registry yang memenuhi syarat, misalnya https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Kredensial untuk mengautentikasi permintaan ke layanan.

options
SchemaRegistryClientOptions

Opsi untuk mengonfigurasi permintaan API ke layanan.

Detail Properti

fullyQualifiedNamespace

URL namespace layanan Schema Registry yang sepenuhnya memenuhi syarat.

fullyQualifiedNamespace: string

Nilai Properti

string

Detail Metode

getSchema(string, GetSchemaOptions)

Mendapatkan skema yang ada berdasarkan ID. Jika skema tidak ditemukan, RestError dengan kode status 404 akan dilemparkan, yang dapat ditangkap sebagai berikut:

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

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

Parameter

schemaId

string

ID skema unik.

options
GetSchemaOptions

Mengembalikan

Promise<Schema>

Skema dengan ID yang diberikan.

getSchema(string, string, number, GetSchemaOptions)

Mendapatkan skema yang ada menurut versi. Jika skema tidak ditemukan, RestError dengan kode status 404 akan dilemparkan, yang dapat ditangkap sebagai berikut:

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

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

Parameter

name

string

groupName

string

version

number

options
GetSchemaOptions

Mengembalikan

Promise<Schema>

Skema dengan ID yang diberikan.

Keterangan

Jika klien menggunakan versi API lama yang tidak mendukung format skema, format skema dapat mengembalikan nilai di header jenis konten. Silakan tingkatkan ke klien menggunakan versi API terbaru sehingga dapat mengembalikan format skema yang benar.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Mendapatkan ID skema yang ada dengan nama, grup, jenis, dan definisi yang cocok.

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

Parameter

schema
SchemaDescription

Skema yang cocok.

options
GetSchemaPropertiesOptions

Mengembalikan

Promise<SchemaProperties>

ID skema yang cocok.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Mendaftarkan skema baru dan mengembalikan ID-nya.

Jika skema nama yang ditentukan tidak ada dalam grup yang ditentukan, skema dibuat pada versi 1. Jika skema nama yang ditentukan sudah ada dalam grup yang ditentukan, skema dibuat pada versi terbaru + 1.

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

Parameter

schema
SchemaDescription

Skema untuk mendaftar.

options
RegisterSchemaOptions

Mengembalikan

Promise<SchemaProperties>

ID skema terdaftar.