CbsClient class

Pakiet:

@azure/core-amqp

Opisuje klienta usługi EventHub/ServiceBus Cbs, który komunikuje się z punktem końcowym $cbs za pośrednictwem połączenia AMQP.

Konstruktory

CbsClient(Connection, string)

Właściwości

cbsLock	Unikatowa nazwa blokady na sesję $cbs na połączenie, które jest używane do uzyskiwania blokady do ustanawiania sesji cbs, jeśli nie istnieje dla połączenia amqp.
connection	Połączenie AMQP.
connectionLock	Unikatowa nazwa blokady na połączenie używane do uzyskiwania blokady do ustanawiania połączenia amqp, jeśli nie istnieje.
endpoint	Punkt końcowy CBS — "$cbs"
replyTo	Odpowiedź CBSTo — nazwa linku odbiorcy, do którego powinna odpowiadać usługa.

Metody

close()	Zamyka sesję cbs protokołu AMQP do usługi EventHub/ServiceBus dla tego klienta, zwracając obietnicę, która zostanie rozwiązana po zakończeniu rozłączenia.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Tworzy pojedyncze wystąpienie sesji CBS, jeśli nie zostało zainicjowane wcześniej w danym połączeniu.
isOpen()	Wskazuje, czy link odbiorcy cbs jest otwarty, czy zamknięty.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Negocjuje roszczenie CBS z usługą EventHub/ServiceBus.
remove()	Usuwa sesję cbs protokołu AMQP do usługi EventHub/ServiceBus dla tego klienta,

Szczegóły konstruktora

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parametry

connection

Connection

Połączenie AMQP.

connectionLock

string

Unikatowe parametry (zwykle identyfikator GUID) na połączenie.

Szczegóły właściwości

cbsLock

Unikatowa nazwa blokady na sesję $cbs na połączenie, które jest używane do uzyskiwania blokady do ustanawiania sesji cbs, jeśli nie istnieje dla połączenia amqp.

cbsLock: string

Wartość właściwości

string

connection

Połączenie AMQP.

connection: Connection

Wartość właściwości

Connection

connectionLock

Unikatowa nazwa blokady na połączenie używane do uzyskiwania blokady do ustanawiania połączenia amqp, jeśli nie istnieje.

connectionLock: string

Wartość właściwości

string

endpoint

Punkt końcowy CBS — "$cbs"

endpoint: string

Wartość właściwości

string

replyTo

Odpowiedź CBSTo — nazwa linku odbiorcy, do którego powinna odpowiadać usługa.

replyTo: string

Wartość właściwości

string

Szczegóły metody

close()

Zamyka sesję cbs protokołu AMQP do usługi EventHub/ServiceBus dla tego klienta, zwracając obietnicę, która zostanie rozwiązana po zakończeniu rozłączenia.

function close(): Promise<void>

Zwraca

Promise<void>

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

Tworzy pojedyncze wystąpienie sesji CBS, jeśli nie zostało zainicjowane wcześniej w danym połączeniu.

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

Parametry

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parametry opcjonalne, których można użyć do wpływania na zachowanie tej metody. Można na przykład przekazać abortSignal, aby zezwolić na anulowanie wywołania init w toku.

Zwraca

Promise<void>

Obietnica<nieważna>.

isOpen()

Wskazuje, czy link odbiorcy cbs jest otwarty, czy zamknięty.

function isOpen(): boolean

Zwraca

boolean

true otwarte, false zamknięte.

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

Negocjuje roszczenie CBS z usługą EventHub/ServiceBus.

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

Parametry

audience

string

Odbiorcy tokenu jednostki, dla których token jest żądany w jednej z następujących formularzy:

• ServiceBus

  • nadawcy

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

  • "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

  • nadawcy

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

  • odbiornika

    • "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

Token, który musi zostać wysłany w żądaniu put-token.

tokenType

TokenType

Typ używanego tokenu. Na przykład "jwt" lub "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parametry opcjonalne, których można użyć do wpływania na zachowanie tej metody. Można na przykład przekazać abortSignal, aby zezwolić na anulowanie wywołania negotiateClaim w toku.

Zwraca

Promise<CbsResponse>

Obietnica, która rozwiązuje problem podczas pomyślnego uwierzytelniania $cbs i odrzuca błąd podczas uwierzytelniania $cbs.

remove()

Usuwa sesję cbs protokołu AMQP do usługi EventHub/ServiceBus dla tego klienta,

function remove()