CbsClient class

Paquete:

@azure/amqp-common

Constructores

CbsClient(Connection, string)

Propiedades

cbsLock	El nombre de bloqueo de unqiue por $cbs sesión por conexión que se usa para adquirir el bloqueo para establecer una sesión cbs si no existe para una conexión aqmp.
connection	Conexión AMQP.
connectionLock	El nombre de bloqueo de unqiue por conexión que se usa para adquirir el bloqueo para establecer una conexión amqp si no existe.
endpoint	Punto de conexión de CBS: "$cbs"
replyTo	CBS replyTo: el nombre del vínculo que el servicio debe responder.

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()	Crea una instancia singleton de la sesión CBS si no se ha inicializado anteriormente en la conexión especificada.
negotiateClaim(string, TokenInfo)	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

La conección AMQP.

connectionLock

string

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

Detalles de las propiedades

cbsLock

El nombre de bloqueo de unqiue por $cbs sesión por conexión que se usa para adquirir el bloqueo para establecer una sesión cbs si no existe para una conexión aqmp.

cbsLock: string

Valor de propiedad

string

connection

Conexión AMQP.

connection: Connection

Valor de propiedad

Connection

connectionLock

El nombre de bloqueo de unqiue por conexión que se usa para adquirir el bloqueo para establecer una conexión amqp si no existe.

connectionLock: string

Valor de propiedad

string

endpoint

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

endpoint: string

Valor de propiedad

string

replyTo

CBS replyTo: el nombre del vínculo que el servicio debe responder.

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()

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

function init(): Promise<void>

Devoluciones

Promise<void>

Promesa<nula>.

negotiateClaim(string, TokenInfo)

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

function negotiateClaim(audience: string, tokenObject: TokenInfo): 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".

tokenObject

TokenInfo

Objeto de token que se debe enviar en la solicitud put-token.

Devoluciones

Promise<CbsResponse>

Devuelve una 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()