CbsClient class

Pacote:

@azure/core-amqp

Descreve o cliente Cbs do EventHub/ServiceBus que conversa com o ponto de extremidade $cbs pela conexão AMQP.

Construtores

CbsClient(Connection, string)

Propriedades

cbsLock	O nome de bloqueio exclusivo por sessão $cbs por conexão que é usado para adquirir o bloqueio para estabelecer uma sessão cbs se não existir para uma conexão amqp.
connection	A conexão AMQP.
connectionLock	O nome de bloqueio exclusivo por conexão que é usado para adquirir o bloqueio para estabelecer uma conexão amqp, caso não exista.
endpoint	Ponto final CBS - "$cbs"
replyTo	CBS replyTo - O nome do link do recetor ao qual o serviço deve responder.

Métodos

close()	Fecha a sessão cbs AMQP para o EventHub/ServiceBus para este cliente, retornando uma promessa que será resolvida quando a desconexão for concluída.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Cria uma instância singleton da sessão CBS se ela não tiver sido inicializada anteriormente na conexão fornecida.
isOpen()	Indica se o link do recetor do remetente cbs está aberto ou fechado.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Negocia a reivindicação CBS com o Serviço EventHub/ServiceBus.
remove()	Remove a sessão cbs AMQP para o EventHub/ServiceBus para este cliente,

Detalhes do Construtor

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parâmetros

connection

Connection

A conexão AMQP.

connectionLock

string

Uma cadeia de caracteres exclusiva (geralmente um guid) por conexão.

Detalhes de Propriedade

cbsLock

O nome de bloqueio exclusivo por sessão $cbs por conexão que é usado para adquirir o bloqueio para estabelecer uma sessão cbs se não existir para uma conexão amqp.

cbsLock: string

Valor de Propriedade

string

connection

A conexão AMQP.

connection: Connection

Valor de Propriedade

Connection

connectionLock

O nome de bloqueio exclusivo por conexão que é usado para adquirir o bloqueio para estabelecer uma conexão amqp, caso não exista.

connectionLock: string

Valor de Propriedade

string

endpoint

Ponto final CBS - "$cbs"

endpoint: string

Valor de Propriedade

string

replyTo

CBS replyTo - O nome do link do recetor ao qual o serviço deve responder.

replyTo: string

Valor de Propriedade

string

Detalhes de Método

close()

Fecha a sessão cbs AMQP para o EventHub/ServiceBus para este cliente, retornando uma promessa que será resolvida quando a desconexão for concluída.

function close(): Promise<void>

Devoluções

Promise<void>

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

Cria uma instância singleton da sessão CBS se ela não tiver sido inicializada anteriormente na conexão fornecida.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser usados para afetar o comportamento desse método. Por exemplo, abortSignal pode ser passado para permitir o cancelamento de uma init em andamento invocação.

Devoluções

Promise<void>

Promessa<vazia>.

isOpen()

Indica se o link do recetor do remetente cbs está aberto ou fechado.

function isOpen(): boolean

Devoluções

boolean

true aberto, false fechado.

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

Negocia a reivindicação CBS com o Serviço EventHub/ServiceBus.

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

Parâmetros

audience

string

O público do token de entidade para o qual o token é solicitado em uma das seguintes formas:

• ServiceBus

  • Remetente

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

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

  • GestãoCliente - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

• EventHubs

  • Remetente

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

  • Recetor

    • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

  • Management do Cliente

    • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".

token

string

O token que precisa ser enviado na solicitação put-token.

tokenType

TokenType

O tipo de token que está sendo usado. Por exemplo, 'jwt' ou 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser usados para afetar o comportamento desse método. Por exemplo, abortSignal pode ser passado para permitir o cancelamento de uma negotiateClaim em andamento invocação.

Devoluções

Promise<CbsResponse>

Uma promessa que resolve quando a autenticação $cbs é bem-sucedida e rejeita quando ocorre um erro durante a autenticação $cbs.

remove()

Remove a sessão cbs AMQP para o EventHub/ServiceBus para este cliente,

function remove()