Dela via

CbsClient class

  • Referens
Paket:
@azure/core-amqp

Beskriver EventHub/ServiceBus Cbs-klienten som pratar med $cbs slutpunkten över AMQP-anslutningen.

Konstruktorer

CbsClient(Connection, string)

Egenskaper

cbsLock

Det unika låsnamnet per $cbs session per anslutning som används för att hämta låset för att upprätta en cbs-session om det inte finns någon för en amqp-anslutning.
connection

AMQP-anslutningen.
connectionLock

Det unika låsnamnet per anslutning som används för att hämta låset för att upprätta en amqp-anslutning om det inte finns någon.
endpoint

CBS-slutpunkt – "$cbs"
replyTo

CBS replyTo – mottagarlänknamnet som tjänsten ska svara på.

Metoder

close()

Stänger AMQP cbs-sessionen till EventHub/ServiceBus för den här klienten och returnerar ett löfte som kommer att lösas när frånkopplingen har slutförts.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Skapar en singleton-instans av CBS-sessionen om den inte har initierats tidigare på den angivna anslutningen.
isOpen()

Anger om cbs-avsändarens mottagarlänk är öppen eller stängd.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Förhandlar om CBS-anspråket med EventHub/ServiceBus-tjänsten.
remove()

Tar bort AMQP cbs-sessionen till EventHub/ServiceBus för den här klienten.

Konstruktorinformation

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Parametrar

connection

Connection

AMQP-anslutningen.

connectionLock

string

En unik sträng (vanligtvis ett guid) per anslutning.

Egenskapsinformation

cbsLock

Det unika låsnamnet per $cbs session per anslutning som används för att hämta låset för att upprätta en cbs-session om det inte finns någon för en amqp-anslutning.

cbsLock: string

Egenskapsvärde

string

connection

AMQP-anslutningen.

connection: Connection

Egenskapsvärde

Connection

connectionLock

Det unika låsnamnet per anslutning som används för att hämta låset för att upprätta en amqp-anslutning om det inte finns någon.

connectionLock: string

Egenskapsvärde

string

endpoint

CBS-slutpunkt – "$cbs"

endpoint: string

Egenskapsvärde

string

replyTo

CBS replyTo – mottagarlänknamnet som tjänsten ska svara på.

replyTo: string

Egenskapsvärde

string

Metodinformation

close()

Stänger AMQP cbs-sessionen till EventHub/ServiceBus för den här klienten och returnerar ett löfte som kommer att lösas när frånkopplingen har slutförts.

function close(): Promise<void>

Returer

Promise<void>

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

Skapar en singleton-instans av CBS-sessionen om den inte har initierats tidigare på den angivna anslutningen.

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

Parametrar

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Valfria parametrar som kan användas för att påverka metodens beteende. Till exempel kan abortSignal skickas så att ett pågående init anrop kan avbrytas.

Returer

Promise<void>

Löfte.

isOpen()

Anger om cbs-avsändarens mottagarlänk är öppen eller stängd.

function isOpen(): boolean

Returer

boolean

true öppen false stängd.

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

Förhandlar om CBS-anspråket med EventHub/ServiceBus-tjänsten.

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

Parametrar

audience

string

Målgruppen för entitetstoken som token begärs för i något av följande formulär:

  • ServiceBus

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

    • mottagare - "sb://<yournamespace>.servicebus.windows.net/<queue-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

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

    • mottagare

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

Den token som måste skickas i put-token-begäran.

tokenType
TokenType

Vilken typ av token som används. Till exempel "jwt" eller "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Valfria parametrar som kan användas för att påverka metodens beteende. Till exempel kan abortSignal skickas så att ett pågående negotiateClaim anrop kan avbrytas.

Returer

Promise<CbsResponse>

Ett löfte som löser när $cbs autentisering lyckas och avvisar när ett fel inträffar under $cbs autentisering.

remove()

Tar bort AMQP cbs-sessionen till EventHub/ServiceBus för den här klienten.

function remove()