Condividi tramite

CbsClient class

  • Riferimento
Pacchetto:
@azure/core-amqp

Descrive il client EventHub/ServiceBus Cbs che comunica con l'endpoint $cbs tramite la connessione AMQP.

Costruttori

CbsClient(Connection, string)

Proprietà

cbsLock

Nome di blocco univoco per $cbs sessione per ogni connessione usata per acquisire il blocco per stabilire una sessione cbs se non esiste per una connessione amqp.
connection

Connessione AMQP.
connectionLock

Nome di blocco univoco per connessione utilizzata per acquisire il blocco per stabilire una connessione amqp se non esiste.
endpoint

Endpoint CBS - "$cbs"
replyTo

CBS replyTo: nome del collegamento del ricevitore a cui il servizio deve rispondere.

Metodi

close()

Chiude la sessione cbs AMQP al client EventHub/ServiceBus, restituendo una promessa che verrà risolta al termine della disconnessione.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Crea un'istanza singleton della sessione CBS se non è stata inizializzata in precedenza nella connessione specificata.
isOpen()

Indica se il collegamento del ricevitore del mittente cbs è aperto o chiuso.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Negozia l'attestazione CBS con il servizio EventHub/ServiceBus.
remove()

Rimuove la sessione cbs di AMQP nel servizio EventHub/ServiceBus per questo client,

Dettagli costruttore

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Parametri

connection

Connection

Connessione AMQP.

connectionLock

string

Stringa univoca (in genere guid) per ogni connessione.

Dettagli proprietà

cbsLock

Nome di blocco univoco per $cbs sessione per ogni connessione usata per acquisire il blocco per stabilire una sessione cbs se non esiste per una connessione amqp.

cbsLock: string

Valore della proprietà

string

connection

Connessione AMQP.

connection: Connection

Valore della proprietà

Connection

connectionLock

Nome di blocco univoco per connessione utilizzata per acquisire il blocco per stabilire una connessione amqp se non esiste.

connectionLock: string

Valore della proprietà

string

endpoint

Endpoint CBS - "$cbs"

endpoint: string

Valore della proprietà

string

replyTo

CBS replyTo: nome del collegamento del ricevitore a cui il servizio deve rispondere.

replyTo: string

Valore della proprietà

string

Dettagli metodo

close()

Chiude la sessione cbs AMQP al client EventHub/ServiceBus, restituendo una promessa che verrà risolta al termine della disconnessione.

function close(): Promise<void>

Restituisce

Promise<void>

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

Crea un'istanza singleton della sessione CBS se non è stata inizializzata in precedenza nella connessione specificata.

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

Parametri

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parametri facoltativi che possono essere usati per influire sul comportamento di questo metodo. Ad esempio, abortSignal può essere passato per consentire l'annullamento di una chiamata in corso init .

Restituisce

Promise<void>

Promessa.

isOpen()

Indica se il collegamento del ricevitore del mittente cbs è aperto o chiuso.

function isOpen(): boolean

Restituisce

boolean

true aprire, false chiuso.

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

Negozia l'attestazione CBS con il servizio EventHub/ServiceBus.

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

Parametri

audience

string

Gruppo di destinatari del token di entità per cui viene richiesto il token in uno dei moduli seguenti:

  • Bus di servizio

    • Mittente

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

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

    • Mittente

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

    • Ricevitore

      • "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 che deve essere inviato nella richiesta put-token.

tokenType
TokenType

Tipo di token usato. Ad esempio, 'jwt' o 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parametri facoltativi che possono essere usati per influire sul comportamento di questo metodo. Ad esempio, abortSignal può essere passato per consentire l'annullamento di una chiamata in corso negotiateClaim .

Restituisce

Promise<CbsResponse>

Promessa che risolve quando l'autenticazione $cbs ha esito positivo e rifiuta quando si verifica un errore durante l'autenticazione $cbs.

remove()

Rimuove la sessione cbs di AMQP nel servizio EventHub/ServiceBus per questo client,

function remove()