Partager via

CbsClient class

  • Référence
Paquet:
@azure/core-amqp

Décrit le client EventHub/ServiceBus Cbs qui communique avec le point de terminaison $cbs via une connexion AMQP.

Constructeurs

CbsClient(Connection, string)

Propriétés

cbsLock

Le nom de verrou unique par $cbs session par connexion qui est utilisé pour acquérir le verrou pour établir une session cbs s’il n’en existe pas pour une connexion amqp.
connection

Connexion AMQP.
connectionLock

Nom de verrou unique par connexion qui est utilisé pour acquérir le verrou pour établir une connexion amqp s’il n’en existe pas.
endpoint

Point de terminaison CBS - « $cbs »
replyTo

CBS replyTo : nom du lien récepteur auquel le service doit répondre.

Méthodes

close()

Ferme la session cbs AMQP à EventHub/ServiceBus pour ce client, en retournant une promesse qui sera résolue une fois la déconnexion terminée.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Crée une instance singleton de la session CBS si elle n’a pas été initialisée précédemment sur la connexion donnée.
isOpen()

Indique si le lien récepteur de l’expéditeur cbs est ouvert ou fermé.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Négocie la revendication CBS avec le service EventHub/ServiceBus.
remove()

Supprime la session cbs AMQP dans EventHub/ServiceBus pour ce client,

Détails du constructeur

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Paramètres

connection

Connection

Connexion AMQP.

connectionLock

string

Chaîne unique (généralement un guid) par connexion.

Détails de la propriété

cbsLock

Le nom de verrou unique par $cbs session par connexion qui est utilisé pour acquérir le verrou pour établir une session cbs s’il n’en existe pas pour une connexion amqp.

cbsLock: string

Valeur de propriété

string

connection

Connexion AMQP.

connection: Connection

Valeur de propriété

Connection

connectionLock

Nom de verrou unique par connexion qui est utilisé pour acquérir le verrou pour établir une connexion amqp s’il n’en existe pas.

connectionLock: string

Valeur de propriété

string

endpoint

Point de terminaison CBS - « $cbs »

endpoint: string

Valeur de propriété

string

replyTo

CBS replyTo : nom du lien récepteur auquel le service doit répondre.

replyTo: string

Valeur de propriété

string

Détails de la méthode

close()

Ferme la session cbs AMQP à EventHub/ServiceBus pour ce client, en retournant une promesse qui sera résolue une fois la déconnexion terminée.

function close(): Promise<void>

Retours

Promise<void>

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

Crée une instance singleton de la session CBS si elle n’a pas été initialisée précédemment sur la connexion donnée.

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

Paramètres

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Paramètres facultatifs qui peuvent être utilisés pour affecter le comportement de cette méthode. Par exemple, abortSignal peut être passé pour autoriser l’annulation d’un appel en cours init .

Retours

Promise<void>

Promesse.

isOpen()

Indique si le lien récepteur de l’expéditeur cbs est ouvert ou fermé.

function isOpen(): boolean

Retours

boolean

true ouvert, false fermé.

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

Négocie la revendication CBS avec le service EventHub/ServiceBus.

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

Paramètres

audience

string

Audience de jeton d’entité pour laquelle le jeton est demandé sous l’une des formes suivantes :

  • ServiceBus

    • Expéditeur

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

    • Récepteur - "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

    • Expéditeur

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

    • Destinataire

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

Jeton qui doit être envoyé dans la demande put-token.

tokenType
TokenType

Type de jeton utilisé. Par exemple, « jwt » ou « servicebus.windows.net:sastoken ».

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Paramètres facultatifs qui peuvent être utilisés pour affecter le comportement de cette méthode. Par exemple, abortSignal peut être passé pour autoriser l’annulation d’un appel en cours negotiateClaim .

Retours

Promise<CbsResponse>

Promesse qui se résout lorsque l’authentification $cbs réussit et rejette lorsqu’une erreur se produit pendant l’authentification $cbs.

remove()

Supprime la session cbs AMQP dans EventHub/ServiceBus pour ce client,

function remove()