Introdução a tópicos e assinaturas do Barramento de Serviço do Azure (.NET)
Este guia de início rápido mostra como enviar mensagens para um tópico do Barramento de Serviço e receber mensagens de uma assinatura para esse tópico usando a biblioteca .NET Azure.Messaging.ServiceBus.
Neste guia de início rápido, você vai realizar as seguintes etapas:
- Crie um namespace do Barramento de Serviço usando o portal do Azure.
- Crie um tópico do Barramento de Serviço usando o portal do Azure.
- Crie uma assinatura do Barramento de Serviço para esse tópico usando o portal do Azure.
- Escreva um aplicativo de console .NET para enviar um conjunto de mensagens ao tópico.
- Escreva um aplicativo de console do .NET para receber essas mensagens da assinatura.
Observação
Este guia de início rápido apresenta instruções passo a passo para implementar um cenário simples de envio de um lote de mensagens para um tópico de Barramento de Serviço e recebimento dessas mensagens de uma assinatura do tópico. Para obter mais exemplos de outros cenários avançados, consulte Exemplos de Barramento de Serviço .NET no GitHub.
- Este início rápido mostra duas maneiras de se conectar ao Barramento de Serviço do Azure: cadeia de conexão e sem senha. A primeira opção mostra como usar uma cadeia de conexão para se conectar a um namespace do Barramento de Serviço. A segunda opção mostra como usar sua entidade de segurança no Microsoft Entra ID e o controle de acesso baseado em função (RBAC) para se conectar a um namespace do Barramento de Serviço. Você não precisa se preocupar em ter uma cadeia de conexão embutida no código, em um arquivo de configuração ou em um armazenamento seguro, como o Azure Key Vault. Se você é novo no Azure, talvez a opção de cadeia de caracteres de conexão seja mais fácil de seguir. É recomendável usar a opção sem senha em aplicativos do mundo real e ambientes de produção. Para obter mais informações, confira Autenticação e autorização.
Pré-requisitos
Se não conhecer muito bem o serviço, confira a Visão geral do Barramento de Serviço antes de começar com este guia de início rápido.
- Assinatura do Azure. Para usar os serviços do Azure, incluindo o Barramento de Serviço do Azure, você precisa ter uma assinatura. Caso tenha uma conta do Azure, poderá se inscrever em uma avaliação gratuita.
- Visual Studio 2022. O aplicativo de exemplo usa novos recursos que foram introduzidos no C# 10. Ainda pode utilizar a biblioteca de clientes do Barramento de Serviço com versões anteriores da linguagem C#, mas a sintaxe pode variar. Para usar a sintaxe mais recente, recomendamos instalar o .NET 6.0 ou superior e configurar a versão da linguagem como
latest
. Se você estiver usando o Visual Studio, as versões anteriores ao Visual Studio 2022 não serão compatíveis com as ferramentas necessárias para compilar projetos do C# 10.
Criar um namespace no Portal do Azure
Para começar a usar as entidades de mensagens do Barramento de Serviço no Azure, primeiro é necessário criar um namespace com um nome exclusivo no Azure. Um namespace fornece um contêiner de escopo para recursos do Barramento de Serviço (filas, tópicos, etc.) dentro de seu aplicativo.
Para criar um namespace:
Entre no portal do Azure.
Navegue até Página Todos os serviços.
Na barra de navegação à esquerda, selecione Integração na lista de categorias. Passe o mouse sobre Barramento de Serviço e, em seguida, selecione o botão + no bloco do Barramento de Serviço.
Na marca Informações Básicas da página Criar namespace, siga estas etapas:
Em Assinatura, escolha uma assinatura do Azure na qual criar o namespace.
Em Grupo de recursos, escolha um grupo de recursos existente ou crie um.
Insira um nome para o namespace. O nome do namespace deve estar de acordo com as convenções de nomenclatura abaixo:
- O nome deve ser exclusivo em todo o Azure. O sistema imediatamente verifica para ver se o nome está disponível.
- O nome deve ter no mínimo seis e no máximo 50 caracteres.
- O nome pode conter apenas letras, números e hifens
-
. - O nome precisa começar com uma letra e terminar com uma letra ou um número.
- O nome não termina com
-sb
ou-mgmt
.
Em Localização, escolha a região na qual o namespace deve ser hospedado.
Selecione o Tipo de preço (Básico, Standard ou Premium) do namespace. Para esse início rápido, selecione Padrão.
Se você escolher a camada Premium, selecione se pode habilitar a replicação geográfica para o namespace. O recurso de replicação geográfica garante que os metadados e os dados de um namespace sejam replicados continuamente de uma região primária para uma ou mais regiões secundárias.
Importante
Se você quiser usar tópicos e assinaturas, escolha Standard ou Premium. Não há suporte para os tópicos/assinaturas no tipo de preço básico.
Se você selecionou o tipo de preço Premium, especifique o número de unidades do sistema de mensagens. A camada Premium fornece isolamento de recursos no nível de CPU e memória, de modo que cada carga de trabalho seja executada isoladamente. Esse contêiner de recursos é chamado de unidade do sistema de mensagens. Um namespace premium tem pelo menos uma unidade do sistema de mensagens. Você pode selecionar 1, 2, 4, 8 ou 16 unidades do sistema de mensagens para cada namespace Premium do Barramento de Serviço. Para saber mais, confira Sistema de Mensagens Premium do Barramento de Serviço.
Selecione Revisar + criar na parte inferior da página.
Na páginaRevisar + criar,revise as configurações e selecioneCriar.
Depois que a implantação do recurso for bem-sucedida, selecione Ir para o recurso na página de implantação.
Você verá a home page do namespace do barramento de serviço.
Criar um tópico usando o portal do Azure
Na página Namespace do Barramento de Serviço, expanda Entidades no menu de navegação à esquerda e selecione Tópicos no menu à esquerda.
Selecione + Tópico na barra de ferramentas.
Insira um nome para o tópico. Deixe as outras opções com os valores padrão.
Selecione Criar.
Criar uma assinatura para o tópico
Selecione o tópico que você criou na seção anterior.
Na página Tópico de Barramento de Serviço, selecione + Assinatura na barra de ferramentas.
Na página Criar assinatura, siga estas etapas:
Insira S1 em Nome da assinatura.
Insira 3 em Contagem máxima de entregas.
Em seguida, selecione Criar para criar a assinatura.
Autenticar o aplicativo no Azure
Este início rápido mostra duas maneiras de se conectar ao Barramento de Serviço do Azure: sem senha e cadeia de conexão.
A primeira opção mostra como usar sua entidade de segurança no Microsoft Entra ID e o RBAC (controle de acesso baseado em função) para se conectar a um namespace do Barramento de Serviço. Você não precisa se preocupar em ter uma cadeia de conexão embutida no código, em um arquivo de configuração ou em um armazenamento seguro, como o Azure Key Vault.
A segunda opção mostra como usar uma cadeia de conexão para se conectar a um namespace do Barramento de Serviço. Se você for novo no Azure, poderá achar a opção de cadeia de conexão mais fácil de ser seguida. É recomendável usar a opção sem senha em aplicativos do mundo real e ambientes de produção. Para obter mais informações, confira Autenticação e autorização. Você também pode ler mais sobre a autenticação sem senha na página de visão geral.
Atribuir funções ao usuário do Microsoft Entra
Ao desenvolver localmente, a conta de usuário que se conecta ao Barramento de Serviço do Azure deve ter as permissões corretas. Você precisará da função Proprietário de Dados do Barramento de Serviço do Azure para enviar e receber mensagens. Para atribuir essa função a si mesmo, você precisará da função Administrador de acesso do usuário ou de outra função que inclua a ação Microsoft.Authorization/roleAssignments/write
. É possível atribuir funções RBAC do Azure a um usuário usando o portal do Azure, a CLI do Azure ou o Azure PowerShell. Saiba mais sobre os escopos disponíveis para atribuições de função na página de visão geral do escopo.
O exemplo a seguir atribui a função Azure Service Bus Data Owner
à sua conta de usuário, que fornece acesso completo aos recursos do Barramento de Serviço do Azure. Em um cenário real, siga o Princípio do Privilégio Mínimo para dar aos usuários apenas as permissões mínimas necessárias para um ambiente de produção mais seguro.
Funções internas do Azure para o Barramento de Serviço do Azure
Para o Barramento de Serviço do Azure, o gerenciamento de namespaces e de todos os recursos relacionados por meio do portal do Azure e da API de gerenciamento de recursos do Azure já está protegido pelo modelo RBAC do Azure. O Azure fornece as funções internas do Azure abaixo para autorizar o acesso a um namespace do Barramento de Serviço:
- Proprietário de Dados do Barramento de Serviço do Azure: habilita o acesso a dados ao namespace do Barramento de Serviço e as entidades dele (filas, tópicos, assinaturas e filtros). Um membro dessa função pode enviar e receber mensagens de filas ou tópicos/assinaturas.
- Remetente de Dados do Barramento de Serviço do Azure: use essa função para fornecer acesso de envio ao namespace do Barramento de Serviço e às entidades dele.
- Receptor de Dados do Barramento de Serviço do Azure: use essa função para conceder acesso de recebimento ao namespace do barramento de serviço e suas entidades.
Se você quiser criar uma função personalizada, consulte Direitos exigidos para operações do Barramento de Serviço.
Adicionar usuário do Microsoft Entra à função Proprietário do Barramento de Serviço do Azure
Adicione seu nome de usuário do Microsoft Entra à função de Proprietário de Dados do Barramento de Serviço do Azure no nível do namespace do Barramento de Serviço. Ele permitirá que um aplicativo em execução no contexto de sua conta de usuário envie mensagens para uma fila ou um tópico e receba mensagens de uma fila ou assinatura de um tópico.
Importante
Na maioria dos casos, levará um ou dois minutos para a atribuição de função se propagar no Azure. Em casos raros, poderá levar até oito minutos. Se você receber erros de autenticação ao executar o código pela primeira vez, aguarde alguns instantes e tente novamente.
Se você a página Namespace do Barramento de Serviço não estiver aberta no portal do Azure, localize o namespace do Barramento de Serviço usando a barra de pesquisa principal ou a navegação à esquerda.
Na página de visão geral, selecione Controle de acesso (IAM) no menu à esquerda.
Na página Controle de acesso (IAM), selecione a guia Atribuições de função.
Selecione + Adicionar no menu superior e, em seguida, Adicionar atribuição de função no menu suspenso resultante.
Use a caixa de pesquisa para filtrar os resultados para a função desejada. Neste exemplo, pesquise
Azure Service Bus Data Owner
e selecione o resultado correspondente. Em seguida, escolha Avançar.Em Atribuir acesso a, selecione Usuário, grupo ou entidade de serviço e, em seguida, selecione + Selecionar membros.
No diálogo, pesquise seu nome de usuário do Microsoft Entra (geralmente seu endereço de email user@domain) e escolha Selecionar na parte inferior do diálogo.
Selecione Revisar + atribuir para ir para a página final e, em seguida, Revisar + atribuir novamente para concluir o processo.
Iniciar o Visual Studio e entrar no Azure
Você pode autorizar o acesso ao namespace do barramento de serviço usando as seguintes etapas:
Inicie o Visual Studio. Se você vir a janela Introdução, selecione o link Continuar sem código no painel direito.
Selecione o botão Entrar no canto superior direito do Visual Studio.
Entre usando a conta do Microsoft Entra à qual você atribuiu uma função anteriormente.
Enviar mensagens para o tópico
Esta seção mostra como criar um aplicativo de console .NET para enviar mensagens para um tópico do Barramento de Serviço.
Observação
Este guia de início rápido apresenta instruções passo a passo para implementar um cenário simples de envio de um lote de mensagens para um tópico de Barramento de Serviço e recebimento dessas mensagens de uma assinatura do tópico. Para obter mais exemplos de outros cenários avançados, consulte Exemplos de Barramento de Serviço .NET no GitHub.
Criar um aplicativo de console
- No Visual Studio, selecione o menu Arquivo ->Novo ->Projeto.
- Na caixa de diálogo Criar um projeto, execute as seguintes etapas: Se essa caixa de diálogo não for exibida, selecione Arquivo no menu, Novo e, em seguida, Projeto.
Selecione C# como a linguagem de programação.
Selecione Console como o tipo do aplicativo.
Selecione Aplicativo de Console na lista de resultados.
Em seguida, selecione Avançar.
- Insira TopicSender no nome do projeto, ServiceBusTopicQuickStart no nome da solução e selecione Próximo.
- Na página Informações adicionais, selecione Criar para criar a solução e o projeto.
Adicionar os pacotes do NuGet ao projeto
Selecione Ferramentas>Gerenciador de Pacotes NuGet>Console do Gerenciador de Pacotes no menu.
Execute o comando a seguir para instalar o pacote NuGet Azure.Messaging.ServiceBus.
Install-Package Azure.Messaging.ServiceBus
Execute o comando a seguir para instalar o pacote NuGet Azure.Identity.
Install-Package Azure.Identity
Adicionar um código para enviar mensagens para o tópico
Substitua os conteúdos do Program.cs pelo código a seguir. As etapas importantes estão descritas nesta seção, com informações adicionais nos comentários do código.
- Cria um objeto ServiceBusClient usando o objeto
DefaultAzureCredential
.DefaultAzureCredential
descobre e usa automaticamente as credenciais de sua entrada do Visual Studio para autenticar no Barramento de Serviço do Azure. - Invoca o método CreateSender no objeto
ServiceBusClient
a fim de criar um objeto ServiceBusSender para o tópico específico do Barramento de Serviço. - Cria um objeto do ServiceBusMessageBatch usando o ServiceBusSender.CreateMessageBatchAsync.
- Adiciona mensagens ao lote usando o método ServiceBusMessageBatch.TryAddMessage.
- Envia o lote de mensagens ao tópico do Barramento de Serviço usando o método ServiceBusSender.SendMessagesAsync.
Importante
Atualize os valores do espaço reservado (
<NAMESPACE-NAME>
e<TOPIC-NAME>
) no snippet de código com os nomes do namespace e do tópico do Barramento de Serviço.using System.Threading.Tasks; using Azure.Messaging.ServiceBus; using Azure.Identity; // the client that owns the connection and can be used to create senders and receivers ServiceBusClient client; // the sender used to publish messages to the topic ServiceBusSender sender; // number of messages to be sent to the topic const int numOfMessages = 3; // The Service Bus client types are safe to cache and use as a singleton for the lifetime // of the application, which is best practice when messages are being published or read // regularly. //TODO: Replace the "<NAMESPACE-NAME>" and "<TOPIC-NAME>" placeholders. client = new ServiceBusClient( "<NAMESPACE-NAME>.servicebus.windows.net", new DefaultAzureCredential()); sender = client.CreateSender("<TOPIC-NAME>"); // create a batch using ServiceBusMessageBatch messageBatch = await sender.CreateMessageBatchAsync(); for (int i = 1; i <= numOfMessages; i++) { // try adding a message to the batch if (!messageBatch.TryAddMessage(new ServiceBusMessage($"Message {i}"))) { // if it is too large for the batch throw new Exception($"The message {i} is too large to fit in the batch."); } } try { // Use the producer client to send the batch of messages to the Service Bus topic await sender.SendMessagesAsync(messageBatch); Console.WriteLine($"A batch of {numOfMessages} messages has been published to the topic."); } finally { // Calling DisposeAsync on client types is required to ensure that network // resources and other unmanaged objects are properly cleaned up. await sender.DisposeAsync(); await client.DisposeAsync(); } Console.WriteLine("Press any key to end the application"); Console.ReadKey();
- Cria um objeto ServiceBusClient usando o objeto
Compile o projeto e verifique se não há erros.
Execute o programa e aguarde a mensagem de confirmação.
A batch of 3 messages has been published to the topic
Importante
Na maioria dos casos, levará um ou dois minutos para a atribuição de função se propagar no Azure. Em casos raros, pode demorar até oito minutos. Se você receber erros de autenticação ao executar o código pela primeira vez, aguarde alguns instantes e tente novamente.
No portal do Azure, siga estas etapas:
Acesse o namespace do Barramento de Serviço.
Na página Visão geral, no painel inferior central, alterne para a guia Tópicos e selecione o tópico do Barramento de Serviço. No exemplo a seguir, ele é
mytopic
.Na página Tópico do Barramento de Serviço, no gráfico Mensagens da seção inferior Métricas, você verá que há três mensagens de entrada para o tópico. Se o valor não for exibido, aguarde alguns minutos e atualize a página para ver o gráfico atualizado.
Selecione a assinatura no painel inferior. No exemplo a seguir, ela é S1. Na página Assinatura do Barramento de Serviço, você verá a Contagem de mensagens ativas como 3. A assinatura recebeu as três mensagens que você enviou para o tópico, mas nenhum destinatário as selecionou ainda.
Receber mensagens de uma assinatura
Nesta seção, crie um aplicativo de console .NET que receba mensagens da assinatura do tópico do Barramento de Serviço do Azure.
Observação
Este guia de início rápido apresenta instruções passo a passo para implementar um cenário simples de envio de um lote de mensagens para um tópico de Barramento de Serviço e recebimento dessas mensagens de uma assinatura do tópico. Para obter mais exemplos de outros cenários avançados, consulte Exemplos de Barramento de Serviço .NET no GitHub.
Criar um projeto para o receptor
- Na janela do Gerenciador de Soluções, clique com o botão direito do mouse na solução ServiceBusTopicQuickStart, aponte para Adicionar e selecione Novo projeto.
- Selecione Aplicativo de console e Próximo.
- Insira SubscriptionReceiver para o nome Project eselecione Próximo.
- Na página Informações adicionais, selecione Criar.
- Na janela Gerenciador de Soluções, clique com o botão direito do mouse em SubscriptionReceiver e selecione Definir como um Projeto de Inicialização.
Adicionar os pacotes do NuGet ao projeto
Selecione Ferramentas>Gerenciador de Pacotes NuGet>Console do Gerenciador de Pacotes no menu.
Selecione SubscriptionReceiver para a lista suspensa Projeto padrão.
Execute o comando a seguir para instalar o pacote NuGet Azure.Messaging.ServiceBus.
Install-Package Azure.Messaging.ServiceBus
Execute o comando a seguir para instalar o pacote NuGet Azure.Identity.
Install-Package Azure.Identity
Adicione o código para receber mensagens da assinatura
Nesta seção, adicione o código para recuperar mensagens da assinatura.
Substitua o conteúdo existente das
Program.cs
seguintes propriedades e métodos:using System.Threading.Tasks; using Azure.Messaging.ServiceBus; using Azure.Identity; // the client that owns the connection and can be used to create senders and receivers ServiceBusClient client; // the processor that reads and processes messages from the subscription ServiceBusProcessor processor; // handle received messages async Task MessageHandler(ProcessMessageEventArgs args) { string body = args.Message.Body.ToString(); Console.WriteLine($"Received: {body} from subscription."); // complete the message. messages is deleted from the subscription. await args.CompleteMessageAsync(args.Message); } // handle any errors when receiving messages Task ErrorHandler(ProcessErrorEventArgs args) { Console.WriteLine(args.Exception.ToString()); return Task.CompletedTask; }
Acrescente o código a seguir ao final de
Program.cs
.- Cria um objeto ServiceBusClient usando o objeto
DefaultAzureCredential
.DefaultAzureCredential
descobre e usa automaticamente as credenciais de sua entrada do Visual Studio para autenticar no Barramento de Serviço do Azure. - Invoca o método CreateProcessor no objeto
ServiceBusClient
para criar um objeto ServiceBusProcessor para o tópico do Barramento de Serviço especificado. - Especifica os manipuladores dos eventos ProcessMessageAsync e ProcessErrorAsync do objeto
ServiceBusProcessor
. - Inicia o processamento de mensagens invocando o método StartProcessingAsync no objeto
ServiceBusProcessor
. - Quando o usuário pressionar uma tecla para encerrar o processamento, ele invocará o método StopProcessingAsync no objeto
ServiceBusProcessor
.
Importante
Atualize os valores do espaço reservado (
<NAMESPACE-NAME>
,<TOPIC-NAME>
e<SUBSCRIPTION-NAME>
) no snippet de código com os nomes do namespace, tópico e assinatura do Barramento de Serviço.Para obter mais informações, consulte comentários de código.
// The Service Bus client types are safe to cache and use as a singleton for the lifetime // of the application, which is best practice when messages are being published or read // regularly. // // Create the clients that we'll use for sending and processing messages. // TODO: Replace the <NAMESPACE-NAME> placeholder client = new ServiceBusClient( "<NAMESPACE-NAME>.servicebus.windows.net", new DefaultAzureCredential()); // create a processor that we can use to process the messages // TODO: Replace the <TOPIC-NAME> and <SUBSCRIPTION-NAME> placeholders processor = client.CreateProcessor("<TOPIC-NAME>", "<SUBSCRIPTION-NAME>", new ServiceBusProcessorOptions()); try { // add handler to process messages processor.ProcessMessageAsync += MessageHandler; // add handler to process any errors processor.ProcessErrorAsync += ErrorHandler; // start processing await processor.StartProcessingAsync(); Console.WriteLine("Wait for a minute and then press any key to end the processing"); Console.ReadKey(); // stop processing Console.WriteLine("\nStopping the receiver..."); await processor.StopProcessingAsync(); Console.WriteLine("Stopped receiving messages"); } finally { // Calling DisposeAsync on client types is required to ensure that network // resources and other unmanaged objects are properly cleaned up. await processor.DisposeAsync(); await client.DisposeAsync(); }
- Cria um objeto ServiceBusClient usando o objeto
Veja como
Program.cs
deve ficar:using System; using System.Threading.Tasks; using Azure.Messaging.ServiceBus; using Azure.Identity; // the client that owns the connection and can be used to create senders and receivers ServiceBusClient client; // the processor that reads and processes messages from the subscription ServiceBusProcessor processor; // handle received messages async Task MessageHandler(ProcessMessageEventArgs args) { string body = args.Message.Body.ToString(); Console.WriteLine($"Received: {body} from subscription."); // complete the message. messages is deleted from the subscription. await args.CompleteMessageAsync(args.Message); } // handle any errors when receiving messages Task ErrorHandler(ProcessErrorEventArgs args) { Console.WriteLine(args.Exception.ToString()); return Task.CompletedTask; } // The Service Bus client types are safe to cache and use as a singleton for the lifetime // of the application, which is best practice when messages are being published or read // regularly. // // Create the clients that we'll use for sending and processing messages. // TODO: Replace the <NAMESPACE-NAME> placeholder client = new ServiceBusClient( "<NAMESPACE-NAME>.servicebus.windows.net", new DefaultAzureCredential()); // create a processor that we can use to process the messages // TODO: Replace the <TOPIC-NAME> and <SUBSCRIPTION-NAME> placeholders processor = client.CreateProcessor("<TOPIC-NAME>", "<SUBSCRIPTION-NAME>", new ServiceBusProcessorOptions()); try { // add handler to process messages processor.ProcessMessageAsync += MessageHandler; // add handler to process any errors processor.ProcessErrorAsync += ErrorHandler; // start processing await processor.StartProcessingAsync(); Console.WriteLine("Wait for a minute and then press any key to end the processing"); Console.ReadKey(); // stop processing Console.WriteLine("\nStopping the receiver..."); await processor.StopProcessingAsync(); Console.WriteLine("Stopped receiving messages"); } finally { // Calling DisposeAsync on client types is required to ensure that network // resources and other unmanaged objects are properly cleaned up. await processor.DisposeAsync(); await client.DisposeAsync(); }
Compile o projeto e verifique se não há erros.
Execute o aplicativo receptor. Você verá as mensagens recebidas. Pressione qualquer tecla para interromper o recebimento e o aplicativo.
Wait for a minute and then press any key to end the processing Received: Message 1 from subscription: S1 Received: Message 2 from subscription: S1 Received: Message 3 from subscription: S1 Stopping the receiver... Stopped receiving messages
Verifique o portal novamente.
Na página Tópico do Barramento de Serviço, no gráfico Mensagens, você verá três mensagens de entrada e três mensagens de saída. Se esses números não forem exibidos, aguarde alguns minutos e atualize a página para ver o gráfico atualizado.
Na página Assinatura do Barramento de Serviço, você verá a Contagem de mensagens ativas como zero. Isso ocorre porque um receptor recebeu mensagens dessa assinatura e concluiu as mensagens.
Próximas etapas
Confira os seguintes exemplos e a documentação: