Partilhar via

ServiceBusClient class

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

Um cliente que pode criar instâncias do Remetente para enviar mensagens para filas e tópicos, bem como instâncias de Recetor para receber mensagens de filas e subscrições.

Construtores

ServiceBusClient(string, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser utilizada para criar remetentes e recetores para o espaço de nomes Azure Service Bus fornecido na cadeia de ligação. Não é efetuada qualquer ligação ao serviço até que os remetentes/recetores criados com o cliente sejam utilizados para enviar/receber mensagens.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

Cria uma instância da classe ServiceBusClient que pode ser utilizada para criar remetentes e recetores para o espaço de nomes Azure Service Bus fornecido. Não é efetuada qualquer ligação ao serviço até que os remetentes/recetores criados com o cliente sejam utilizados para enviar/receber mensagens.

Propriedades

fullyQualifiedNamespace

O espaço de nomes completamente qualificado da instância do Service Bus para a qual este cliente é criado. É provável que seja semelhante a .servicebus.windows.net.
identifier

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

Métodos

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Cria um recetor para a próxima sessão disponível numa fila de Azure Service Bus ativada por sessão.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

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

Cria um recetor para a próxima sessão disponível numa subscrição de Azure Service Bus ativada por sessão.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

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

Cria um recetor para uma sessão ativada Azure Service Bus fila.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 recetor para uma sessão ativada Azure Service Bus subscrição.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

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

Fecha a ligação AMQP subjacente. NOTA: esta ação também irá desligar quaisquer instâncias do Recetor ou Remetente criadas a partir desta instância.
createReceiver(string, ServiceBusReceiverOptions)

Cria um recetor para uma fila de Azure Service Bus. Não é efetuada qualquer ligação ao serviço até que um dos métodos no recetor seja chamado.

Para direcionar sub filas, como a fila de letras mortas ou a fila de cartas sem saída de transferência, indique as subQueue opções. Para saber mais sobre as filas de letras não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

As mensagens que não forem resolvidas durante a duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na fila, após a qual são enviadas para uma fila de letras mortas separada.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

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

Cria um recetor para uma subscrição Azure Service Bus. Não é efetuada qualquer ligação ao serviço até que um dos métodos no recetor seja chamado.

Para direcionar sub filas, como a fila de letras mortas ou a fila de cartas sem saída de transferência, indique as subQueue opções. Para saber mais sobre as filas de letras não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

As mensagens que não forem resolvidas durante a duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na subscrição, após a qual são enviadas para uma fila de cartas sem saída separada.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 é utilizada para gerir as regras de uma subscrição.
createSender(string, ServiceBusSenderOptions)

Cria um Remetente que pode ser utilizado para enviar mensagens, agendar mensagens para serem enviadas mais tarde e cancelar essas mensagens agendadas. Não é efetuada qualquer ligação ao 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 utilizada para criar remetentes e recetores para o espaço de nomes Azure Service Bus fornecido na cadeia de ligação. Não é efetuada qualquer ligação ao serviço até que os remetentes/recetores criados com o cliente sejam utilizados para enviar/receber mensagens.

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

Parâmetros

connectionString

string

Uma cadeia de ligação para Azure Service Bus espaço de nomes. NOTA: esta cadeia de ligação pode conter um EntityPath, que é ignorado.

options
ServiceBusClientOptions

Opções para o cliente do service bus.

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

Cria uma instância da classe ServiceBusClient que pode ser utilizada para criar remetentes e recetores para o espaço de nomes Azure Service Bus fornecido. Não é efetuada qualquer ligação ao serviço até que os remetentes/recetores criados com o cliente sejam utilizados para enviar/receber mensagens.

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

Parâmetros

fullyQualifiedNamespace

string

O espaço de nomes completo da sua instância do Service Bus, que provavelmente será semelhante a .servicebus.windows.net.

credential

TokenCredential | NamedKeyCredential | SASCredential

Um objeto de credencial utilizado pelo cliente para obter o token para autenticar a ligação com o Azure Service Bus. Veja @azure/identidade para criar as credenciais. Se estiver a utilizar uma implementação própria da TokenCredential interface no AAD, defina os "âmbitos" do service-bus para ["https://servicebus.azure.net//user_impersonation"] obter o token adequado. Utilize a AzureNamedKeyCredential de @azure/core-auth se quiser transmitir uma SharedAccessKeyName e SharedAccessKey sem utilizar uma cadeia de ligação. Estes campos mapeiam para o name campo e key , respetivamente, em AzureNamedKeyCredential. Utilize a AzureSASCredential de @azure/core-auth se quiser transmitir uma SharedAccessSignature sem utilizar uma cadeia de ligação. Este campo mapeia para signature em AzureSASCredential.

options
ServiceBusClientOptions

Um conjunto de opções a aplicar 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 ligação AMQP através de Sockets Web.

Detalhes de Propriedade

fullyQualifiedNamespace

O espaço de nomes completamente qualificado da instância do Service Bus para a qual este cliente é criado. É provável que seja semelhante a .servicebus.windows.net.

fullyQualifiedNamespace: string

Valor de Propriedade

string

identifier

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

identifier: string

Valor de Propriedade

string

Detalhes de Método

acceptNextSession(string, ServiceBusSessionReceiverOptions)

Cria um recetor para a próxima sessão disponível numa fila de Azure Service Bus ativada por sessão.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 a receber.

options
ServiceBusSessionReceiverOptions

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

Devoluções

Promise<ServiceBusSessionReceiver>

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

Cria um recetor para a próxima sessão disponível numa subscrição de Azure Service Bus ativada por sessão.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 subscrição da qual queremos receber.

subscriptionName

string

Nome da subscrição (em topic) da qual queremos receber.

options
ServiceBusSessionReceiverOptions

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

Devoluções

Promise<ServiceBusSessionReceiver>

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

Cria um recetor para uma sessão ativada Azure Service Bus fila.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 a receber.

sessionId

string

O ID da sessão a partir da qual as mensagens têm de ser recebidas

options
ServiceBusSessionReceiverOptions

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

Devoluções

Promise<ServiceBusSessionReceiver>

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

Cria um recetor para uma sessão ativada Azure Service Bus subscrição.

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 subscrição da qual queremos receber.

subscriptionName

string

Nome da subscrição (em topic) da qual queremos receber.

sessionId

string

O ID da sessão a partir da qual as mensagens têm de ser recebidas

options
ServiceBusSessionReceiverOptions

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

Devoluções

Promise<ServiceBusSessionReceiver>

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

close()

Fecha a ligação AMQP subjacente. NOTA: esta ação também irá desligar quaisquer instâncias do Recetor ou Remetente criadas a partir desta instância.

function close(): Promise<void>

Devoluções

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Cria um recetor para uma fila de Azure Service Bus. Não é efetuada qualquer ligação ao serviço até que um dos métodos no recetor seja chamado.

Para direcionar sub filas, como a fila de letras mortas ou a fila de cartas sem saída de transferência, indique as subQueue opções. Para saber mais sobre as filas de letras não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

As mensagens que não forem resolvidas durante a duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na fila, após a qual são enviadas para uma fila de letras mortas separada.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 a receber.

options
ServiceBusReceiverOptions

Opções para passar o receiveMode, predefinido para peekLock.

Devoluções

ServiceBusReceiver

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

createReceiver(string, string, ServiceBusReceiverOptions)

Cria um recetor para uma subscrição Azure Service Bus. Não é efetuada qualquer ligação ao serviço até que um dos métodos no recetor seja chamado.

Para direcionar sub filas, como a fila de letras mortas ou a fila de cartas sem saída de transferência, indique as subQueue opções. Para saber mais sobre as filas de letras não entregues, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Pode escolher entre dois modos de receção: "peekLock" (predefinição) e "receiveAndDelete".

  • No modo peekLock, o recetor tem um bloqueio na mensagem durante a duração especificada na fila.
  • No modo receiveAndDelete, as mensagens são eliminadas do Service Bus à medida que são recebidas.

As mensagens que não forem resolvidas durante a duração do bloqueio serão resgatadas tantas vezes como a contagem máxima de entrega definida na subscrição, após a qual são enviadas para uma fila de cartas sem saída separada.

Pode resolver uma mensagem ao chamar métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.

Mais informações sobre como o peekLock e a resoluçã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 subscrição da qual queremos receber.

subscriptionName

string

Nome da subscrição (em topic) da qual queremos receber.

options
ServiceBusReceiverOptions

Opções para passar o receiveMode, predefinido para peekLock.

Devoluções

ServiceBusReceiver

Um recetor que pode ser utilizado para receber, pré-visualizar e resolver mensagens.

createRuleManager(string, string)

Cria uma instância do ServiceBusRuleManager que é utilizada para gerir as regras de uma subscrição.

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

Parâmetros

topicName

string

o tópico para criar o ServiceBusRuleManager

subscriptionName

string

a subscrição específica do tópico especificado para criar um ServiceBusRuleManager para.

Devoluções

ServiceBusRuleManager

um ServiceBusRuleManager no âmbito da subscrição e tópico especificados.

createSender(string, ServiceBusSenderOptions)

Cria um Remetente que pode ser utilizado para enviar mensagens, agendar mensagens para serem enviadas mais tarde e cancelar essas mensagens agendadas. Não é efetuada qualquer ligação ao 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 onde enviar mensagens.

options
ServiceBusSenderOptions

Devoluções

ServiceBusSender