Partilhar via

CbsClient class

  • Referência
Pacote:
@azure/core-amqp

Descreve o cliente EventHub/ServiceBus Cbs que comunica com o ponto final $cbs através da ligação AMQP.

Construtores

CbsClient(Connection, string)

Propriedades

cbsLock

O nome de bloqueio exclusivo por $cbs sessão por ligação que é utilizado para adquirir o bloqueio para estabelecer uma sessão de cbs se não existir para uma ligação amqp.
connection

A ligação AMQP.
connectionLock

O nome de bloqueio exclusivo por ligação que é utilizado para adquirir o bloqueio para estabelecer uma ligação amqp, se não existir.
endpoint

Ponto final cbs - "$cbs"
replyTo

CBS replyTo - O nome da ligação do recetor ao qual o serviço deve responder.

Métodos

close()

Fecha a sessão de cbs amQP para o EventHub/ServiceBus para este cliente, devolvendo uma promessa que será resolvida quando a desconexão estiver concluída.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Cria uma instância singleton da sessão de CBS se não tiver sido inicializada anteriormente na ligação especificada.
isOpen()

Indica se a ligação do recetor do remetente cbs está aberta ou fechada.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Negoceia a afirmação da CBS com o Serviço EventHub/ServiceBus.
remove()

Remove a sessão de 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 ligação AMQP.

connectionLock

string

Uma cadeia exclusiva (normalmente um guid) por ligação.

Detalhes de Propriedade

cbsLock

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

cbsLock: string

Valor de Propriedade

string

connection

A ligação AMQP.

connection: Connection

Valor de Propriedade

Connection

connectionLock

O nome de bloqueio exclusivo por ligação que é utilizado para adquirir o bloqueio para estabelecer uma ligação amqp, se não existir.

connectionLock: string

Valor de Propriedade

string

endpoint

Ponto final cbs - "$cbs"

endpoint: string

Valor de Propriedade

string

replyTo

CBS replyTo - O nome da ligação do recetor ao qual o serviço deve responder.

replyTo: string

Valor de Propriedade

string

Detalhes de Método

close()

Fecha a sessão de cbs amQP para o EventHub/ServiceBus para este cliente, devolvendo uma promessa que será resolvida quando a desconexão estiver concluída.

function close(): Promise<void>

Devoluções

Promise<void>

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

Cria uma instância singleton da sessão de CBS se não tiver sido inicializada anteriormente na ligação especificada.

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

Parâmetros

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser utilizados para afetar o comportamento deste método. Por exemplo, abortSignal pode ser transmitido para permitir o cancelamento de uma invocação em curso init .

Devoluções

Promise<void>

Prometa.

isOpen()

Indica se a ligação do recetor do remetente cbs está aberta ou fechada.

function isOpen(): boolean

Devoluções

boolean

true aberto, false fechado.

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

Negoceia a afirmação da 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

A audiência do token de entidade para a qual o token é pedido num dos seguintes formulários:

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

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

    • ManagementClient

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

string

O token que tem de ser enviado no pedido put-token.

tokenType
TokenType

O tipo de token que está a ser utilizado. Por exemplo, "jwt" ou "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parâmetros opcionais que podem ser utilizados para afetar o comportamento deste método. Por exemplo, abortSignal pode ser transmitido para permitir o cancelamento de uma invocação em curso negotiateClaim .

Devoluções

Promise<CbsResponse>

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

remove()

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

function remove()