Usar o Service Bus Explorer para executar operações de dados no Service Bus

Artigo
11/30/2023

O Barramento de Serviço do Azure permite que os aplicativos cliente remetente e recetor desacoplem sua lógica de negócios com o uso da semântica familiar ponto-a-ponto (Fila) e publicação-assinatura (Topic-Subscription).

Nota

Este artigo destaca a funcionalidade do Azure Service Bus Explorer que faz parte do portal do Azure.

O Service Bus Explorer de código aberto de propriedade da comunidade é um aplicativo independente e é diferente deste.

As operações executadas em um namespace do Barramento de Serviço do Azure são de dois tipos.

Operações de gerenciamento - Crie, atualize, exclua namespace, filas, tópicos e assinaturas do Service Bus.
Operações de dados - Envie e receba mensagens de filas, tópicos e assinaturas.

Importante

O Service Bus Explorer não oferece suporte a operações e sessões de gerenciamento.
Aconselhamos contra o uso do Service Bus Explorer para mensagens maiores, pois isso pode resultar em tempos limites, dependendo do tamanho da mensagem, latência de rede entre o cliente e o serviço do Service Bus, etc. Em vez disso, recomendamos que você use seu próprio cliente para trabalhar com mensagens maiores, onde você pode especificar seus próprios valores de tempo limite.

Pré-requisitos

Para usar a ferramenta Service Bus Explorer, você precisa executar as seguintes tarefas:

Crie um namespace do Barramento de Serviço do Azure.
Crie uma fila para enviar e receber mensagens ou um tópico com uma assinatura para testar a funcionalidade. Para saber como criar filas, tópicos e assinaturas, consulte os seguintes artigos:
- Guia de início rápido - Criar filas
- Guia de início rápido - Criar tópicos
Nota

Se não for o namespace que você criou, verifique se você é membro de uma destas funções no namespace:

Usar o Service Bus Explorer

Para usar o Service Bus Explorer, navegue até o namespace do Service Bus no qual você deseja fazer operações de dados.

Se você estiver procurando executar operações em uma fila, selecione Filas no menu de navegação. Se você estiver procurando executar operações em um tópico (e suas assinaturas relacionadas), selecione Tópicos.
Depois de selecionar Filas ou Tópicos, selecione a fila ou tópico específico.
Selecione o Service Bus Explorer no menu de navegação esquerdo

Nota

Ao espiar ou receber de uma assinatura, primeiro selecione a Assinatura específica no seletor suspenso.

Espreitar uma mensagem

Com a funcionalidade de visualização, você pode usar o Service Bus Explorer para exibir as 100 principais mensagens em uma fila, assinatura ou fila de mensagens mortas.

Para visualizar mensagens, selecione Modo de Visualização na lista suspensa Gerenciador do Service Bus.
Verifique as métricas para ver se há Mensagens Ativas ou Mensagens com letras mortas para espiar e selecione a subfila Queue/Subscription ou DeadLetter.
Selecione o botão Espreitar a partir do início .
Quando a operação de visualização for concluída, até 100 mensagens aparecerão na grade, conforme mostrado na imagem a seguir. Para visualizar os detalhes de uma mensagem específica, selecione-a na grade. Você pode optar por exibir o corpo ou as propriedades da mensagem.

Alterne para a guia Propriedades da mensagem no painel inferior para ver os metadados.

Nota

Como a visualização não é uma operação destrutiva, a mensagem não será removida da entidade.

Nota

Por motivos de desempenho, ao espiar mensagens de uma fila ou assinatura que tenha seu tamanho máximo de mensagem definido acima de 1MB, o corpo da mensagem não será recuperado por padrão. Em vez disso, você pode carregar o corpo da mensagem para uma mensagem específica clicando no botão Carregar corpo da mensagem. Se o corpo da mensagem tiver mais de 1MB, ele será truncado antes de ser exibido.

Espreite uma mensagem com opções avançadas

A funcionalidade espiar com opções permite que você use o Service Bus Explorer para exibir as principais mensagens em uma fila, assinatura ou fila de mensagens mortas, especificando o número de mensagens a serem espiadas e o número de sequência para iniciar a operação de espiada.

Para visualizar mensagens com opções avançadas, selecione Modo de Visualização no menu suspenso Service Bus Explorer.
Verifique as métricas para ver se há Mensagens Ativas ou Mensagens com letras mortas para espiar e selecione a subfila Queue/Subscription ou DeadLetter.
Selecione o botão Espreitar com opções . Forneça o número de mensagens a espreitar e o número de sequência a partir do qual começar a espreitar e selecione o botão Espreitar .
Quando a operação de visualização for concluída, as mensagens aparecerão na grade, conforme mostrado na imagem a seguir. Para visualizar os detalhes de uma mensagem específica, selecione-a na grade. Você pode optar por exibir o corpo ou as propriedades da mensagem.

Alterne para a guia Propriedades da mensagem no painel inferior para ver os metadados.

Nota

Como a visualização não é uma operação destrutiva, a mensagem não será removida da fila.

Receber uma mensagem

A função de recebimento no Service Bus Explorer permite receber mensagens de uma fila ou assinatura.

Para receber mensagens, selecione Modo de recebimento no menu suspenso Service Bus Explorer.
Verifique as métricas para ver se há Mensagens Ativas ou Mensagens com letras mortas para receber e selecione Fila/Assinatura ou DeadLetter.
Selecione o botão Receber mensagens e especifique o modo de recebimento, o número de mensagens a receber e o tempo máximo de espera por uma mensagem e selecione Receber.

Importante

Observe que o modo ReceiveAndDelete é um recebimento destrutivo, ou seja, a mensagem é removida da fila quando é exibida na ferramenta Service Bus Explorer.

Para procurar mensagens sem removê-las da fila, considere usar a funcionalidade Peek ou o modo de recebimento PeekLock.
Quando a operação de recebimento for concluída, as mensagens aparecerão na grade, conforme mostrado na imagem a seguir. Para visualizar os detalhes de uma mensagem específica, selecione-a na grade.

Nota

Por motivos de desempenho, ao receber mensagens de uma fila ou assinatura que tenha seu tamanho máximo de mensagem definido acima de 1MB, apenas uma mensagem será recebida de cada vez. Se o corpo da mensagem tiver mais de 1MB, ele será truncado antes de ser exibido.

Depois que uma mensagem é recebida no modo PeekLock , há várias ações que podemos tomar nela.

Nota

Só podemos tomar essas medidas enquanto tivermos um bloqueio na mensagem.

Concluir uma mensagem

Na grade, selecione a(s) mensagem(ões) recebida(s) que queremos concluir.
Selecione o botão Concluir .

Importante

Observe que o preenchimento de uma mensagem é uma receção destrutiva, ou seja, a mensagem é removida da fila quando Concluído foi selecionado na ferramenta Service Bus Explorer.

Adiar uma mensagem

Na grade, selecione a(s) mensagem(ões) recebida(s) que queremos adiar.
Selecione o botão Adiar .

Abandone a fechadura

Na grade, selecione a(s) mensagem(ões) recebida(s) para a(s) qual(is) queremos abandonar o bloqueio.
Selecione o botão Abandonar bloqueio.

Depois que o bloqueio for abandonado, a mensagem estará disponível para operações de recebimento novamente.

Carta morta

Na grelha, selecione a(s) mensagem(ões) recebida(s) que queremos colocar letra morta.
Selecione o botão Letra morta.

Depois que uma mensagem tiver sido escrita com letra morta, ela estará disponível na subfila Letra morta.

Enviar uma mensagem para uma fila ou tópico

Para enviar uma mensagem para uma fila ou um tópico, selecione o botão Enviar mensagens do Service Bus Explorer.

Selecione o Tipo de Conteúdo para ser Text/Plain, Application/Xml ou Application/Json.
Em Corpo da mensagem, adicione o conteúdo da mensagem. Certifique-se de que corresponde ao Tipo de Conteúdo definido anteriormente.
Defina as propriedades do Broker (opcional) - elas incluem ID de Correlação, ID da Mensagem, ReplyTo, Rótulo/Assunto, Tempo de Vida (TTL) e Tempo de Enfila Agendado (para Mensagens Agendadas).
Definir as Propriedades Personalizadas (opcional) - estas podem ser quaisquer propriedades de utilizador definidas em relação a uma chave de dicionário.
Marque Repetir envio para enviar a mesma mensagem várias vezes. Se nenhuma ID de mensagem tiver sido definida, ela será automaticamente preenchida com valores sequenciais.
Depois que a mensagem tiver sido composta, selecione o botão Enviar .
Quando a operação de envio for concluída com êxito, ocorrerá uma das seguintes situações:
- Se enviar para uma fila, o contador de métricas do Ative Messages será incrementado.
- Se enviar para um tópico, o contador de métricas do Ative Messages será incrementado nas Assinaturas para as quais a mensagem foi roteada.

Reenviar uma mensagem

Depois de espreitar ou receber uma mensagem, podemos reenviá-la, o que enviará uma cópia da mensagem para a mesma entidade, permitindo-nos atualizar o seu conteúdo e propriedades. O original permanecerá e não será excluído, mesmo quando o reenvio for da fila de deadletters.

Na grade, selecione a(s) mensagem(ões) que queremos reenviar.
Selecione o botão Reenviar mensagens selecionadas .
Opcionalmente, selecione qualquer mensagem para a qual queremos atualizar seus detalhes e faça as alterações desejadas.
Selecione o botão Enviar para enviar as mensagens para a entidade.
Nota
- A operação de reenvio envia uma cópia da mensagem original. Ele não remove a mensagem original que você reenvia.
- Se você reenviar uma mensagem em uma fila de mensagens mortas de uma assinatura, uma cópia da mensagem será enviada para o tópico. Portanto, todas as assinaturas receberão uma cópia da mensagem.