Compartilhar via

ServiceBusClient class

  • Referência
Pacote:
@azure/service-bus

Um cliente que pode criar instâncias de Remetente para enviar mensagens para filas e tópicos, bem como instâncias de receptor para receber mensagens de filas e assinaturas.

Construtores

ServiceBusClient(string, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e receptores para o namespace Barramento de Serviço do Azure fornecido na cadeia de conexão. Nenhuma conexão é feita com o serviço até que os remetentes/receptores criados com o cliente sejam usados para enviar/receber mensagens.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e receptores para o namespace Barramento de Serviço do Azure fornecido. Nenhuma conexão é feita com o serviço até que os remetentes/receptores criados com o cliente sejam usados para enviar/receber mensagens.

Propriedades

fullyQualifiedNamespace

O namespace totalmente qualificado da instância do Barramento de Serviço para a qual esse cliente é criado. É provável que isso seja semelhante a .servicebus.windows.net.
identifier

O nome usado para identificar esse ServiceBusClient. Se não for especificado ou vazio, um aleatório exclusivo será gerado.

Métodos

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Cria um receptor para a próxima sessão disponível em uma fila de Barramento de Serviço do Azure habilitada para sessão.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para a próxima sessão disponível em uma assinatura de Barramento de Serviço do Azure habilitada para sessão.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para uma sessão habilitada Barramento de Serviço do Azure fila.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para uma sessão habilitada Barramento de Serviço do Azure assinatura.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()

Fecha a conexão AMQP subjacente. OBSERVAÇÃO: isso também desconectará todas as instâncias de Receptor ou Remetente criadas dessa instância.
createReceiver(string, ServiceBusReceiverOptions)

Cria um receptor para uma fila de Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no receptor seja chamado.

Para direcionar sub filas como a fila de mensagens mortas ou a fila de mensagens mortas de transferência, forneça o subQueue nas opções. Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na fila, após a qual elas são enviadas para uma fila de mensagens mortas separada.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)

Cria um receptor para uma assinatura Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no receptor seja chamado.

Para direcionar sub filas como a fila de mensagens mortas ou a fila de mensagens mortas de transferência, forneça o subQueue nas opções. Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na assinatura, após a qual elas são enviadas para uma fila de mensagens mortas separada.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)

Cria uma instância do ServiceBusRuleManager que é usada para gerenciar as regras de uma assinatura.
createSender(string, ServiceBusSenderOptions)

Cria um Remetente que pode ser usado para enviar mensagens, agendar mensagens a serem enviadas posteriormente e cancelar essas mensagens agendadas. Nenhuma conexão é feita com o serviço até que um dos métodos no remetente seja chamado.

Detalhes do construtor

ServiceBusClient(string, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e receptores para o namespace Barramento de Serviço do Azure fornecido na cadeia de conexão. Nenhuma conexão é feita com o serviço até que os remetentes/receptores criados com o cliente sejam usados para enviar/receber mensagens.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

Parâmetros

connectionString

string

Uma cadeia de conexão para Barramento de Serviço do Azure namespace. OBSERVAÇÃO: essa cadeia de conexão pode conter um EntityPath, que é ignorado.

options
ServiceBusClientOptions

Opções para o cliente do barramento de serviço.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e receptores para o namespace Barramento de Serviço do Azure fornecido. Nenhuma conexão é feita com o serviço até que os remetentes/receptores criados com o cliente sejam usados para enviar/receber mensagens.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

Parâmetros

fullyQualifiedNamespace

string

O namespace completo da instância do Barramento de Serviço que provavelmente será semelhante a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Um objeto de credencial usado pelo cliente para obter o token para autenticar a conexão com o Barramento de Serviço do Azure. Consulte @azure/identity para criar as credenciais. Se você estiver usando uma implementação própria da TokenCredential interface no AAD, defina os "escopos" para o barramento de serviço para ["https://servicebus.azure.net//user_impersonation"] obter o token apropriado. Use o AzureNamedKeyCredential de @azure/core-auth se você quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o name campo e key , respectivamente, em AzureNamedKeyCredential. Use o AzureSASCredential de @azure/core-auth se quiser passar um SharedAccessSignature sem usar uma cadeia de conexão. Esse campo é mapeado para signature em AzureSASCredential.

options
ServiceBusClientOptions

Um conjunto de opções a serem aplicadas ao configurar o cliente.

  • retryOptions : configura a política de repetição para todas as operações no cliente. Por exemplo, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets.

Detalhes da propriedade

fullyQualifiedNamespace

O namespace totalmente qualificado da instância do Barramento de Serviço para a qual esse cliente é criado. É provável que isso seja semelhante a .servicebus.windows.net.

fullyQualifiedNamespace: string

Valor da propriedade

string

identifier

O nome usado para identificar esse ServiceBusClient. Se não for especificado ou vazio, um aleatório exclusivo será gerado.

identifier: string

Valor da propriedade

string

Detalhes do método

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Cria um receptor para a próxima sessão disponível em uma fila de Barramento de Serviço do Azure habilitada para sessão.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parâmetros

queueName

string

O nome da fila da qual receber.

options
ServiceBusSessionReceiverOptions

As opções incluem receiveMode(padrão para peekLock), opções para criar o receptor de sessão.

Retornos

Promise<ServiceBusSessionReceiver>

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para a próxima sessão disponível em uma assinatura de Barramento de Serviço do Azure habilitada para sessão.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parâmetros

topicName

string

Nome do tópico da assinatura da qual queremos receber.

subscriptionName

string

Nome da assinatura (sob o topic) da qual desejamos receber.

options
ServiceBusSessionReceiverOptions

As opções incluem receiveMode(padrão para peekLock), opções para criar o receptor de sessão.

Retornos

Promise<ServiceBusSessionReceiver>

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para uma sessão habilitada Barramento de Serviço do Azure fila.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parâmetros

queueName

string

O nome da fila da qual receber.

sessionId

string

A ID da sessão da qual as mensagens precisam ser recebidas

options
ServiceBusSessionReceiverOptions

As opções incluem receiveMode(padrão para peekLock), opções para criar o receptor de sessão.

Retornos

Promise<ServiceBusSessionReceiver>

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Cria um receptor para uma sessão habilitada Barramento de Serviço do Azure assinatura.

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

Parâmetros

topicName

string

Nome do tópico da assinatura da qual queremos receber.

subscriptionName

string

Nome da assinatura (sob o topic) da qual desejamos receber.

sessionId

string

A ID da sessão da qual as mensagens precisam ser recebidas

options
ServiceBusSessionReceiverOptions

As opções incluem receiveMode(padrão para peekLock), opções para criar o receptor de sessão.

Retornos

Promise<ServiceBusSessionReceiver>

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

close()

Fecha a conexão AMQP subjacente. OBSERVAÇÃO: isso também desconectará todas as instâncias de Receptor ou Remetente criadas dessa instância.

function close(): Promise<void>

Retornos

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Cria um receptor para uma fila de Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no receptor seja chamado.

Para direcionar sub filas como a fila de mensagens mortas ou a fila de mensagens mortas de transferência, forneça o subQueue nas opções. Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na fila, após a qual elas são enviadas para uma fila de mensagens mortas separada.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parâmetros

queueName

string

O nome da fila da qual receber.

options
ServiceBusReceiverOptions

Opções para passar o receiveMode, padrão para peekLock.

Retornos

ServiceBusReceiver

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

createReceiver(string, string, ServiceBusReceiverOptions)

Cria um receptor para uma assinatura Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no receptor seja chamado.

Para direcionar sub filas como a fila de mensagens mortas ou a fila de mensagens mortas de transferência, forneça o subQueue nas opções. Para saber mais sobre filas de mensagens mortas, confira https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Você pode escolher entre dois modos de recebimento: "peekLock" (padrão) e "receiveAndDelete".

  • No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.

As mensagens que não forem resolvidas dentro da duração do bloqueio serão entregues novamente tantas vezes quanto a contagem máxima de entrega definida na assinatura, após a qual elas são enviadas para uma fila de mensagens mortas separada.

Você pode resolver uma mensagem chamando métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no receptor.

Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

Parâmetros

topicName

string

Nome do tópico da assinatura da qual desejamos receber.

subscriptionName

string

Nome da assinatura (sob o topic) da qual desejamos receber.

options
ServiceBusReceiverOptions

Opções para passar o receiveMode, com o padrão peekLock.

Retornos

ServiceBusReceiver

Um receptor que pode ser usado para receber, espiar e liquidar mensagens.

createRuleManager(string, string)

Cria uma instância do ServiceBusRuleManager que é usada para gerenciar as regras de uma assinatura.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

Parâmetros

topicName

string

o tópico para criar ServiceBusRuleManager

subscriptionName

string

a assinatura específica para o tópico especificado para o qual criar um ServiceBusRuleManager .

Retornos

ServiceBusRuleManager

um ServiceBusRuleManager com escopo para a assinatura e o tópico especificados.

createSender(string, ServiceBusSenderOptions)

Cria um Remetente que pode ser usado para enviar mensagens, agendar mensagens a serem enviadas posteriormente e cancelar essas mensagens agendadas. Nenhuma conexão é feita com o serviço até que um dos métodos no remetente seja chamado.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

Parâmetros

queueOrTopicName

string

O nome de uma fila ou tópico para o qual enviar mensagens.

options
ServiceBusSenderOptions

Retornos

ServiceBusSender