CbsClient class

Balíček:

@azure/core-amqp

Popisuje klienta EventHub/ServiceBus Cbs, který komunikuje s koncovým bodem $cbs přes připojení AMQP.

Konstruktory

CbsClient(Connection, string)

Vlastnosti

cbsLock	Jedinečný název zámku na relaci $cbs na připojení, které se používá k získání zámku pro navázání relace cbs, pokud pro připojení amqp neexistuje.
connection	Připojení AMQP.
connectionLock	Jedinečný název zámku pro každé připojení, které se používá k získání zámku pro navázání připojení amqp, pokud neexistuje.
endpoint	Koncový bod CBS – "$cbs"
replyTo	CBS replyTo - Název odkazu příjemce, na který má služba odpovědět.

Metody

close()	Zavře relaci cbs AMQP na EventHub/ServiceBus pro tohoto klienta a vrátí příslib, který se vyřeší po dokončení odpojení.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Vytvoří jednu instanci relace CBS, pokud nebyla dříve inicializována u daného připojení.
isOpen()	Určuje, zda je odkaz příjemce cbs otevřený nebo uzavřený.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Vyjedná deklaraci identity CBS se službou EventHub/ServiceBus.
remove()	Odebere relaci cbs AMQP do EventHubu nebo ServiceBusu pro tohoto klienta.

Podrobnosti konstruktoru

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parametry

connection

Connection

Připojení AMQP.

connectionLock

string

Jedinečný řetězec (obvykle guid) na připojení.

Podrobnosti vlastnosti

cbsLock

Jedinečný název zámku na relaci $cbs na připojení, které se používá k získání zámku pro navázání relace cbs, pokud pro připojení amqp neexistuje.

cbsLock: string

Hodnota vlastnosti

string

connection

Připojení AMQP.

connection: Connection

Hodnota vlastnosti

Connection

connectionLock

Jedinečný název zámku pro každé připojení, které se používá k získání zámku pro navázání připojení amqp, pokud neexistuje.

connectionLock: string

Hodnota vlastnosti

string

endpoint

Koncový bod CBS – "$cbs"

endpoint: string

Hodnota vlastnosti

string

replyTo

CBS replyTo - Název odkazu příjemce, na který má služba odpovědět.

replyTo: string

Hodnota vlastnosti

string

Podrobnosti metody

close()

Zavře relaci cbs AMQP na EventHub/ServiceBus pro tohoto klienta a vrátí příslib, který se vyřeší po dokončení odpojení.

function close(): Promise<void>

Návraty

Promise<void>

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

Vytvoří jednu instanci relace CBS, pokud nebyla dříve inicializována u daného připojení.

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

Parametry

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Volitelné parametry, které lze použít k ovlivnění chování této metody. Například abortSignal lze předat, aby bylo možné zrušit probíhající init vyvolání.

Návraty

Promise<void>

Slib<je neplatný>.

isOpen()

Určuje, zda je odkaz příjemce cbs otevřený nebo uzavřený.

function isOpen(): boolean

Návraty

boolean

true otevřené, false zavřené.

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

Vyjedná deklaraci identity CBS se službou EventHub/ServiceBus.

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

Parametry

audience

string

Cílová skupina tokenu entity, pro kterou je token požadován v jednom z následujících formulářů:

• servicebusu

  • odesílatele

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

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

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

• EventHubs

  • odesílatele

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

  • přijímače

    • "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, který je potřeba odeslat v požadavku put-token.

tokenType

TokenType

Typ použitého tokenu. Například jwt nebo servicebus.windows.net:sastoken.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Volitelné parametry, které lze použít k ovlivnění chování této metody. Například abortSignal lze předat, aby bylo možné zrušit probíhající negotiateClaim vyvolání.

Návraty

Promise<CbsResponse>

Příslib, který se vyřeší, když je ověřování $cbs úspěšné a odmítne, když dojde k chybě během ověřování $cbs.

remove()

Odebere relaci cbs AMQP do EventHubu nebo ServiceBusu pro tohoto klienta.

function remove()