CbsClient class

Pacchetto:

@azure/core-amqp

Descrive il client Cbs EventHub/ServiceBus 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 utilizzata 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 utilizzato 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 all'entità EventHub/ServiceBus per questo client, 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 destinatario 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 AMQP in 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 utilizzata 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 utilizzato 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 all'entità EventHub/ServiceBus per questo client, 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, è possibile passare abortSignal per consentire l'annullamento di una chiamata init in corso.

Restituisce

Promise<void>

Promessa<nulla>.

isOpen()

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

function isOpen(): boolean

Restituisce

boolean

true aperto 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 il quale viene richiesto il token in uno dei formati seguenti:

• servicebus

  • sender

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

  • sender

    • "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 utilizzato. 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, è possibile passare abortSignal per consentire l'annullamento di una chiamata negotiateClaim in corso.

Restituisce

Promise<CbsResponse>

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

remove()

Rimuove la sessione cbs AMQP in EventHub/ServiceBus per questo client,

function remove()