CbsClient class

Paket:

@azure/core-amqp

AMQP bağlantısı üzerinden $cbs uç noktasıyla konuşan EventHub/ServiceBus Cbs istemcisini açıklar.

Oluşturucular

CbsClient(Connection, string)

Özellikler

cbsLock	Amqp bağlantısı için mevcut değilse cbs oturumu oluşturmak için kilidi almak için kullanılan bağlantı başına $cbs oturumu başına benzersiz kilit adı.
connection	AMQP bağlantısı.
connectionLock	Mevcut değilse, amqp bağlantısı kurmak için kilidi almak için kullanılan bağlantı başına benzersiz kilit adı.
endpoint	CBS uç noktası - "$cbs"
replyTo	CBS replyTo - Hizmetin yanıtlaması gereken alıcı bağlantı adı.

Yöntemler

close()	AmQP cbs oturumunu bu istemci için EventHub/ServiceBus'a kapatır ve bağlantı kesilmesi tamamlandığında çözülecek bir söz döndürür.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Verilen bağlantıda daha önce başlatılmadıysa CBS oturumunun tek bir örneğini oluşturur.
isOpen()	CBS gönderen alıcı bağlantısının açık mı yoksa kapalı mı olduğunu gösterir.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	CBS talebi için EventHub/ServiceBus Hizmeti ile anlaşma sağlar.
remove()	Bu istemci için EventHub/ServiceBus'ta AMQP cbs oturumunu kaldırır,

Oluşturucu Ayrıntıları

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parametreler

connection

Connection

AMQP bağlantısı.

connectionLock

string

Bağlantı başına benzersiz bir dize (genellikle guid).

Özellik Ayrıntıları

cbsLock

Amqp bağlantısı için mevcut değilse cbs oturumu oluşturmak için kilidi almak için kullanılan bağlantı başına $cbs oturumu başına benzersiz kilit adı.

cbsLock: string

Özellik Değeri

string

connection

AMQP bağlantısı.

connection: Connection

Özellik Değeri

Connection

connectionLock

Mevcut değilse, amqp bağlantısı kurmak için kilidi almak için kullanılan bağlantı başına benzersiz kilit adı.

connectionLock: string

Özellik Değeri

string

endpoint

CBS uç noktası - "$cbs"

endpoint: string

Özellik Değeri

string

replyTo

CBS replyTo - Hizmetin yanıtlaması gereken alıcı bağlantı adı.

replyTo: string

Özellik Değeri

string

Yöntem Ayrıntıları

close()

AmQP cbs oturumunu bu istemci için EventHub/ServiceBus'a kapatır ve bağlantı kesilmesi tamamlandığında çözülecek bir söz döndürür.

function close(): Promise<void>

Döndürülenler

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Verilen bağlantıda daha önce başlatılmadıysa CBS oturumunun tek bir örneğini oluşturur.

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

Parametreler

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Bu yöntemin davranışını etkilemek için kullanılabilecek isteğe bağlı parametreler. Örneğin, devam eden bir abortSignal çağrının iptal edilmesine izin vermek için init geçirilebilir.

Döndürülenler

Promise<void>

Söz<geçersiz>.

isOpen()

CBS gönderen alıcı bağlantısının açık mı yoksa kapalı mı olduğunu gösterir.

function isOpen(): boolean

Döndürülenler

boolean

true açık, false kapalı.

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

CBS talebi için EventHub/ServiceBus Hizmeti ile anlaşma sağlar.

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

Parametreler

audience

string

Aşağıdaki formlardan birinde belirtecin istendiği varlık belirteci hedef kitlesi:

• ServiceBus

  • Gönderen

    • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
    • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

  • alıcı "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

  • ManagementClient "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

• EventHubs

  • Gönderen

    • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
    • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>".

  • Alıcı

    • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

  • ManagementClient

    • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".

token

string

Put-token isteğinde gönderilmesi gereken belirteç.

tokenType

TokenType

Kullanılan belirteç türü. Örneğin, 'jwt' veya 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Bu yöntemin davranışını etkilemek için kullanılabilecek isteğe bağlı parametreler. Örneğin, devam eden bir abortSignal çağrının iptal edilmesine izin vermek için negotiateClaim geçirilebilir.

Döndürülenler

Promise<CbsResponse>

$cbs kimlik doğrulaması başarılı olduğunda çözümleyen ve $cbs kimlik doğrulaması sırasında bir hata oluştuğunda reddeden bir Promise.

remove()

Bu istemci için EventHub/ServiceBus'ta AMQP cbs oturumunu kaldırır,

function remove()