Compartir a través de

CbsClient class

Paquete:
@azure/core-amqp

Describe el cliente de EventHub/ServiceBus Cbs que se comunica con el punto de conexión de $cbs a través de la conexión AMQP.

Constructores

CbsClient(Connection, string)

Propiedades

cbsLock

Nombre de bloqueo único por $cbs sesión por conexión que se usa para adquirir el bloqueo para establecer una sesión cbs si no existe una conexión amqp.
connection

Conexión AMQP.
connectionLock

Nombre de bloqueo único por conexión que se usa para adquirir el bloqueo para establecer una conexión amqp si no existe una.
endpoint

Punto de conexión de CBS: "$cbs"
replyTo

RESPUESTA DE CBS: el nombre del vínculo receptor al que debe responder el servicio.

Métodos

close()

Cierra la sesión de AMQP cbs en EventHub/ServiceBus para este cliente, devolviendo una promesa que se resolverá cuando se complete la desconexión.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Crea una instancia singleton de la sesión CBS si no se ha inicializado anteriormente en la conexión especificada.
isOpen()

Indica si el vínculo receptor del remitente cbs está abierto o cerrado.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Negocia la notificación CBS con EventHub/ServiceBus Service.
remove()

Quita la sesión de AMQP cbs en EventHub/ServiceBus para este cliente,

Detalles del constructor

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Parámetros

connection

Connection

Conexión AMQP.

connectionLock

string

Una cadena única (normalmente un guid) por conexión.

Detalles de las propiedades

cbsLock

Nombre de bloqueo único por $cbs sesión por conexión que se usa para adquirir el bloqueo para establecer una sesión cbs si no existe una conexión amqp.

cbsLock: string

Valor de propiedad

string

connection

Conexión AMQP.

connection: Connection

Valor de propiedad

Connection

connectionLock

Nombre de bloqueo único por conexión que se usa para adquirir el bloqueo para establecer una conexión amqp si no existe una.

connectionLock: string

Valor de propiedad

string

endpoint

Punto de conexión de CBS: "$cbs"

endpoint: string

Valor de propiedad

string

replyTo

RESPUESTA DE CBS: el nombre del vínculo receptor al que debe responder el servicio.

replyTo: string

Valor de propiedad

string

Detalles del método

close()

Cierra la sesión de AMQP cbs en EventHub/ServiceBus para este cliente, devolviendo una promesa que se resolverá cuando se complete la desconexión.

function close(): Promise<void>

Devoluciones

Promise<void>

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

Crea una instancia singleton de la sesión CBS si no se ha inicializado anteriormente en la conexión especificada.

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

Parámetros

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parámetros opcionales que se pueden usar para afectar al comportamiento de este método. Por ejemplo, se puede pasar abortSignal para permitir la cancelación de una invocación en curso init.

Devoluciones

Promise<void>

Promesa<nula>.

isOpen()

Indica si el vínculo receptor del remitente cbs está abierto o cerrado.

function isOpen(): boolean

Devoluciones

boolean

true abrir, false cerrado.

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

Negocia la notificación CBS con EventHub/ServiceBus Service.

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

Parámetros

audience

string

Audiencia del token de entidad para la que se solicita el token en uno de los siguientes formularios:

  • serviceBus

    • remitente de

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

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

    • AdministraciónCliente - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

  • EventHubs

    • remitente de

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

    • receptor de

      • "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 que se debe enviar en la solicitud put-token.

tokenType
TokenType

Tipo de token que se va a usar. Por ejemplo, "jwt" o "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parámetros opcionales que se pueden usar para afectar al comportamiento de este método. Por ejemplo, se puede pasar abortSignal para permitir la cancelación de una invocación en curso negotiateClaim.

Devoluciones

Promise<CbsResponse>

Promesa que se resuelve cuando $cbs autenticación es correcta y rechaza cuando se produce un error durante $cbs autenticación.

remove()

Quita la sesión de AMQP cbs en EventHub/ServiceBus para este cliente,

function remove()