Sdílet prostřednictvím

CbsClient class

  • Reference
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 $cbs relaci na připojení, která se používá k získání zámku pro vytvoření relace cbs, pokud pro připojení amqp neexistuje.
connection

Připojení AMQP.
connectionLock

Jedinečný název zámku pro připojení, který se použije 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()

Ukončí relaci cbs AMQP s 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 pro dané připojení.
isOpen()

Určuje, jestli je odkaz příjemce cbs odesílatele otevřený nebo zavřený.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Vyjedná žádost CBS se službou EventHub/ServiceBus.
remove()

Odebere relaci cbs protokolu AMQP k EventHubu nebo ServiceBus 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 identifikátor GUID) na připojení.

Podrobnosti vlastnosti

cbsLock

Jedinečný název zámku na $cbs relaci na připojení, která se používá k získání zámku pro vytvoření 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 připojení, který se použije 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()

Ukončí relaci cbs AMQP s 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 pro dané 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. Může se například abortSignal předat, aby bylo možné zrušit probíhající init vyvolání.

Návraty

Promise<void>

Slib.

isOpen()

Určuje, jestli je odkaz příjemce cbs odesílatele otevřený nebo zavřený.

function isOpen(): boolean

Návraty

boolean

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

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

Vyjedná žádost 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 některé z následujících forem:

  • ServiceBus

    • Odesílatel

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

    • Přijímač - "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

    • Odesílatel

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

    • Příjemce

      • "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 tokenu, který se používá. 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. Může se například abortSignal předat, aby bylo možné zrušit probíhající negotiateClaim vyvolání.

Návraty

Promise<CbsResponse>

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

remove()

Odebere relaci cbs protokolu AMQP k EventHubu nebo ServiceBus pro tohoto klienta.

function remove()