ServiceBusClient class
Um cliente que pode criar instâncias de Remetente para enviar mensagens para filas e tópicos, bem como instâncias de Recetor para receber mensagens de filas e assinaturas.
Construtores
| Service |
Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e recetores para o namespace do Barramento de Serviço do Azure fornecido na cadeia de conexão. Nenhuma conexão é feita com o serviço até que os remetentes/recetores criados com o cliente sejam usados para enviar/receber mensagens. |
| Service |
Cria uma instância da classe ServiceBusClient que pode ser usada para criar remetentes e recetores para o namespace do Barramento de Serviço do Azure fornecido. Nenhuma conexão é feita com o serviço até que os remetentes/recetores criados com o cliente sejam usados para enviar/receber mensagens. |
Propriedades
| fully |
O namespace totalmente qualificado da instância do Service Bus para a qual esse cliente é criado. É provável que isso seja semelhante ao <seunamespace.servicebus.windows.net>. |
| identifier | O nome usado para identificar este ServiceBusClient. Se não for especificado ou vazio, um único aleatório será gerado. |
Métodos
| accept |
Cria um recetor para a próxima sessão disponível em uma fila do Barramento de Serviço do Azure habilitada para sessão. Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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 |
| accept |
Cria um recetor para a próxima sessão disponível em uma assinatura do Barramento de Serviço do Azure habilitada para sessão. Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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 |
| accept |
Cria um recetor para uma fila do Barramento de Serviço do Azure habilitada para sessão. Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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 |
| accept |
Cria um recetor para uma assinatura do Barramento de Serviço do Azure habilitada para sessão. Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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. NOTA: isso também desconectará todas as instâncias de Recetor ou Remetente criadas a partir dessa instância. |
| create |
Cria um recetor para uma fila do Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no recetor é chamado. Para direcionar subfilas como a fila de letra morta ou a fila de transferência de letra morta, forneça o Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na fila, após o que serão enviadas para uma fila de cartas mortas separada. Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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 |
| create |
Cria um recetor para uma assinatura do Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no recetor é chamado. Para direcionar subfilas como a fila de letra morta ou a fila de transferência de letra morta, forneça o Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na assinatura, após o que elas serão enviadas para uma fila de mensagens mortas separada. Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor. 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 |
| create |
Cria uma instância de ServiceBusRuleManager que é usada para gerenciar as regras de uma assinatura. |
| create |
Cria um Remetente que pode ser usado para enviar mensagens, agendar mensagens para 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 recetores para o namespace do Barramento de Serviço do Azure fornecido na cadeia de conexão. Nenhuma conexão é feita com o serviço até que os remetentes/recetores 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 o namespace do Barramento de Serviço do Azure. 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 recetores para o namespace do Barramento de Serviço do Azure fornecido. Nenhuma conexão é feita com o serviço até que os remetentes/recetores 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 Service Bus, que provavelmente será semelhante ao <seunamespace.servicebus.windows.net>.
- credential
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 interface TokenCredential em relação ao AAD, defina os "escopos" para o barramento de serviço a ser ["https://servicebus.azure.net//user_impersonation"] para obter o token apropriado.
Use o AzureNamedKeyCredential de @azure/core-auth se quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o campo name e key, respectivamente, em AzureNamedKeyCredential.
Use o AzureSASCredential de @azure/core-auth se quiser passar um SharedAccessSignature sem usar uma cadeia de conexão. Este 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 através de Web Sockets.
Detalhes de Propriedade
fullyQualifiedNamespace
O namespace totalmente qualificado da instância do Service Bus para a qual esse cliente é criado. É provável que isso seja semelhante ao <seunamespace.servicebus.windows.net>.
fullyQualifiedNamespace: stringValor de Propriedade
string
identifier
O nome usado para identificar este ServiceBusClient. Se não for especificado ou vazio, um único aleatório será gerado.
identifier: stringValor de Propriedade
string
Detalhes de Método
acceptNextSession(string, ServiceBusSessionReceiverOptions)
Cria um recetor para a próxima sessão disponível em uma fila do Barramento de Serviço do Azure habilitada para sessão.
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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 a ser recebida.
- options
- ServiceBusSessionReceiverOptions
As opções incluem receiveMode (padrão para peekLock), opções para criar o recetor da sessão.
Devoluções
Promise<ServiceBusSessionReceiver>
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)
Cria um recetor para a próxima sessão disponível em uma assinatura do Barramento de Serviço do Azure habilitada para sessão.
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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 subscrição a partir da qual queremos receber.
- subscriptionName
-
string
Nome da subscrição (sob a topic) da qual queremos receber.
- options
- ServiceBusSessionReceiverOptions
As opções incluem receiveMode (padrão para peekLock), opções para criar o recetor da sessão.
Devoluções
Promise<ServiceBusSessionReceiver>
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
acceptSession(string, string, ServiceBusSessionReceiverOptions)
Cria um recetor para uma fila do Barramento de Serviço do Azure habilitada para sessão.
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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 a ser recebida.
- sessionId
-
string
O id da sessão a partir da qual as mensagens precisam ser recebidas
- options
- ServiceBusSessionReceiverOptions
As opções incluem receiveMode (padrão para peekLock), opções para criar o recetor da sessão.
Devoluções
Promise<ServiceBusSessionReceiver>
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)
Cria um recetor para uma assinatura do Barramento de Serviço do Azure habilitada para sessão.
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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 subscrição a partir da qual queremos receber.
- subscriptionName
-
string
Nome da subscrição (sob a topic) da qual queremos receber.
- sessionId
-
string
O id da sessão a partir da qual as mensagens precisam ser recebidas
- options
- ServiceBusSessionReceiverOptions
As opções incluem receiveMode (padrão para peekLock), opções para criar o recetor da sessão.
Devoluções
Promise<ServiceBusSessionReceiver>
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
close()
Fecha a conexão AMQP subjacente. NOTA: isso também desconectará todas as instâncias de Recetor ou Remetente criadas a partir dessa instância.
function close(): Promise<void>Devoluções
Promise<void>
createReceiver(string, ServiceBusReceiverOptions)
Cria um recetor para uma fila do Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no recetor é chamado.
Para direcionar subfilas como a fila de letra morta ou a fila de transferência de letra morta, forneça o subQueue nas opções. Para saber mais sobre filas de letra morta, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na fila, após o que serão enviadas para uma fila de cartas mortas separada.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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): ServiceBusReceiverParâmetros
- queueName
-
string
O nome da fila a ser recebida.
- options
- ServiceBusReceiverOptions
Opções para passar o receiveMode, padrão para peekLock.
Devoluções
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
createReceiver(string, string, ServiceBusReceiverOptions)
Cria um recetor para uma assinatura do Barramento de Serviço do Azure. Nenhuma conexão é feita com o serviço até que um dos métodos no recetor é chamado.
Para direcionar subfilas como a fila de letra morta ou a fila de transferência de letra morta, forneça o subQueue nas opções. Para saber mais sobre filas de letra morta, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
Você pode escolher entre dois modos de receção: "peekLock" (padrão) e "receiveAndDelete".
- No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila.
- No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na assinatura, após o que elas serão enviadas para uma fila de mensagens mortas separada.
Você pode liquidar uma mensagem chamando os métodos completeMessage(), abandonMessage(), deferMessage() ou deadletterMessage() no recetor.
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): ServiceBusReceiverParâmetros
- topicName
-
string
Nome do tópico da subscrição a partir da qual queremos receber.
- subscriptionName
-
string
Nome da subscrição (sob a topic) da qual queremos receber.
- options
- ServiceBusReceiverOptions
Opções para passar o receiveMode, padrão para peekLock.
Devoluções
Um recetor que pode ser usado para receber, espreitar e liquidar mensagens.
createRuleManager(string, string)
Cria uma instância de ServiceBusRuleManager que é usada para gerenciar as regras de uma assinatura.
function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManagerParâmetros
- topicName
-
string
o tópico para criar ServiceBusRuleManager
- subscriptionName
-
string
a assinatura específica para o tópico especificado para criar um ServiceBusRuleManager.
Devoluções
um ServiceBusRuleManager definido como escopo para a assinatura e o tópico especificados.
createSender(string, ServiceBusSenderOptions)
Cria um Remetente que pode ser usado para enviar mensagens, agendar mensagens para 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): ServiceBusSenderParâmetros
- queueOrTopicName
-
string
O nome de uma fila ou tópico para o qual enviar mensagens.
- options
- ServiceBusSenderOptions