Aracılığıyla paylaş

SchemaRegistryClient class

Paket:
@azure/schema-registry

Azure Schema Registry hizmeti için istemci.

Oluşturucular

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Azure Schema Registry hizmeti için yeni bir istemci oluşturur.

Özellikler

fullyQualifiedNamespace

Schema Registry hizmeti tam ad alanı URL'si.

Yöntemler

getSchema(string, GetSchemaOptions)

Kimliğine göre var olan bir şemayı alır. Şema bulunamazsa, durum kodu 404 olan bir RestError oluşturulur ve bu durum aşağıdaki gibi yakalanabilir:

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

Sürüme göre var olan bir şemayı alır. Şema bulunamazsa, durum kodu 404 olan bir RestError oluşturulur ve bu durum aşağıdaki gibi yakalanabilir:

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

Eşleşen ad, grup, tür ve tanım ile var olan bir şemanın kimliğini alır.
registerSchema(SchemaDescription, RegisterSchemaOptions)

Yeni bir şema kaydeder ve kimliğini döndürür.

Belirtilen adın şeması belirtilen grupta yoksa, sürüm 1'de bir şema oluşturulur. Belirtilen adın şeması belirtilen grupta zaten varsa, şema en son sürüm + 1'de oluşturulur.

Oluşturucu Ayrıntıları

SchemaRegistryClient(string, TokenCredential, SchemaRegistryClientOptions)

Azure Schema Registry hizmeti için yeni bir istemci oluşturur.

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

Parametreler

fullyQualifiedNamespace

string

Schema Registry hizmeti nitelenmiş ad alanı URL'si, örneğin https://mynamespace.servicebus.windows.net.

credential
TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kimlik bilgileri.

options
SchemaRegistryClientOptions

Hizmete API isteklerini yapılandırma seçenekleri.

Özellik Ayrıntıları

fullyQualifiedNamespace

Schema Registry hizmeti tam ad alanı URL'si.

fullyQualifiedNamespace: string

Özellik Değeri

string

Yöntem Ayrıntıları

getSchema(string, GetSchemaOptions)

Kimliğine göre var olan bir şemayı alır. Şema bulunamazsa, durum kodu 404 olan bir RestError oluşturulur ve bu durum aşağıdaki gibi yakalanabilir:

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

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

Parametreler

schemaId

string

Benzersiz şema kimliği.

options
GetSchemaOptions

Döndürülenler

Promise<Schema>

Verilen kimlikle şema.

getSchema(string, string, number, GetSchemaOptions)

Sürüme göre var olan bir şemayı alır. Şema bulunamazsa, durum kodu 404 olan bir RestError oluşturulur ve bu durum aşağıdaki gibi yakalanabilir:

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

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

Parametreler

name

string

groupName

string

version

number

options
GetSchemaOptions

Döndürülenler

Promise<Schema>

Verilen kimlikle şema.

Açıklamalar

İstemci, şemanın biçimini desteklemeyen eski bir API sürümü kullanıyorsa, şema biçimi içerik türü üst bilgisindeki değeri döndürebilir. Doğru şema biçimini döndürebilmesi için lütfen en son API sürümünü kullanarak istemciye yükseltin.

getSchemaProperties(SchemaDescription, GetSchemaPropertiesOptions)

Eşleşen ad, grup, tür ve tanım ile var olan bir şemanın kimliğini alır.

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

Parametreler

schema
SchemaDescription

Eşleşecek şema.

options
GetSchemaPropertiesOptions

Döndürülenler

Promise<SchemaProperties>

Eşleşen şemanın kimliği.

registerSchema(SchemaDescription, RegisterSchemaOptions)

Yeni bir şema kaydeder ve kimliğini döndürür.

Belirtilen adın şeması belirtilen grupta yoksa, sürüm 1'de bir şema oluşturulur. Belirtilen adın şeması belirtilen grupta zaten varsa, şema en son sürüm + 1'de oluşturulur.

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

Parametreler

schema
SchemaDescription

Kaydedilecek şema.

options
RegisterSchemaOptions

Döndürülenler

Promise<SchemaProperties>

Kayıtlı şemanın kimliği.