Enviar e receber mensagens de filas do Barramento de Serviço do Azure (Python)

• C#
• Java
• JavaScript
• Python

Neste tutorial, vai concluir os seguintes passos:

1. Criar um espaço de nomes do Service Bus com o Portal do Azure.
2. Criar uma fila do Service Bus com o portal do Azure.
3. Escreva código Python para usar o pacote azure-servicebus para:
   1. Envie um conjunto de mensagens para a fila.
   2. Receba essas mensagens da fila.

Nota

Este início rápido fornece instruções passo a passo para um cenário simples de enviar mensagens para uma fila do Service Bus e recebê-las. Você pode encontrar exemplos de JavaScript e TypeScript pré-criados para o Barramento de Serviço do Azure no repositório do SDK do Azure para Python no GitHub.

Pré-requisitos

Se você é novo no serviço, consulte Visão geral do Service Bus antes de fazer este início rápido.

• Uma subscrição do Azure. Para concluir este tutorial, precisa de uma conta do Azure. Você pode ativar seus benefícios de assinante do MSDN ou se inscrever para uma conta gratuita.

• Python 3.8 ou superior.

Sem senha (recomendado)

Para usar este início rápido com sua própria conta do Azure:

• Instale a CLI do Azure, que fornece a autenticação sem senha para sua máquina de desenvolvedor.
• Entre com sua conta do Azure no terminal ou prompt de comando com az login.
• Use a mesma conta ao adicionar a função de dados apropriada ao seu recurso.
• Execute o código no mesmo terminal ou prompt de comando.
• Observe o nome da fila para seu namespace do Service Bus. Você precisará disso no código.

Cadeia de Ligação

Observe o seguinte, que você usará no código abaixo:

• Cadeia de conexão de namespace do Service Bus
• Fila de namespace do Barramento de Serviço que você criou

Nota

Este tutorial funciona com exemplos que você pode copiar e executar usando Python. Para obter instruções sobre como criar um aplicativo Python, consulte Criar e implantar um aplicativo Python em um site do Azure. Para obter mais informações sobre como instalar pacotes usados neste tutorial, consulte o Guia de Instalação do Python.

Criar um espaço de nomes no portal do Azure

Para começar a utilizar as entidades de mensagens do Service Bus no Azure, tem de, primeiro, criar um espaço de nomes que seja exclusivo em todo o Azure. Um namespace fornece um contêiner de escopo para recursos do Service Bus (filas, tópicos, etc.) em seu aplicativo.

Para criar um espaço de nomes:

1. Inicie sessão no portal do Azure.

2. Navegue até a página Todos os serviços.

3. Na barra de navegação esquerda, selecione Integração na lista de categorias, passe o mouse sobre o Service Bus e selecione + o botão no bloco do Service Bus.

   

4. Na marca Basics da página Criar namespace, siga estas etapas:

   1. Em Assinatura, escolha uma assinatura do Azure na qual criar o namespace.

   2. Para Grupo de recursos, escolha um grupo de recursos existente no qual o namespace viverá ou crie um novo.

   3. Insira um nome para o namespace. O nome do namespace deve aderir às seguintes convenções de nomenclatura:

      • O nome deve ser exclusivo no Azure. O sistema verifica imediatamente a disponibilidade do nome.
      • O comprimento do nome é de pelo menos 6 e no máximo 50 caracteres.
      • O nome pode conter apenas letras, números hífenes "-".
      • O nome deve começar com uma letra e terminar com uma letra ou número.
      • O nome não termina com "-sb" ou "-mgmt".

   4. Em Local, escolha a região na qual seu namespace deve ser hospedado.

   5. Em Nível de preço, selecione o nível de preço (Básico, Standard ou Premium) para o namespace. Para este início rápido, selecione Padrão.

      Importante

      Se você quiser usar tópicos e assinaturas, escolha Standard ou Premium. Não há suporte para tópicos/assinaturas no nível de preço Básico.

      Se você selecionou o nível de preço Premium, especifique o número de unidades de mensagens. A camada premium fornece isolamento de recursos no nível de CPU e memória para que cada carga de trabalho seja executada isoladamente. Este contentor de recursos é designado por unidade de mensagens. Um namespace premium tem pelo menos uma unidade de mensagens. Você pode selecionar 1, 2, 4, 8 ou 16 unidades de mensagens para cada namespace Premium do Service Bus. Para obter mais informações, consulte Mensagens Premium do Service Bus.

   6. Selecione Rever + criar na parte inferior da página.

      

   7. Na página Rever + criar, reveja as definições e selecione Criar.

5. Quando a implantação do recurso for bem-sucedida, selecione Ir para o recurso na página de implantação.

   

6. Você vê a home page do namespace do barramento de serviço.

   

Criar uma fila no portal do Azure

1. Na página Namespace do Service Bus, selecione Filas no menu de navegação esquerdo.

2. Na página Filas, selecione + Fila na barra de ferramentas.

3. Insira um nome para a fila e deixe os outros valores com seus padrões.

4. Agora, selecione Criar.

   

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 RBAC (controle de acesso baseado em função) para se conectar a um namespace do Service Bus. Você não precisa se preocupar em ter uma cadeia de conexão codificada em seu código ou 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 Service Bus. Se você for novo no Azure, poderá achar a opção de cadeia de conexão mais fácil de seguir. Recomendamos o uso da opção sem senha em aplicativos e ambientes de produção do mundo real. Para obter mais informações, consulte Autenticação e autorização. Você também pode ler mais sobre autenticação sem senha na página de visão geral.

Sem senha (recomendado)

Atribuir funções ao usuário do Microsoft Entra

Ao desenvolver localmente, verifique se a conta de usuário que se conecta ao Barramento de Serviço do Azure tem 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 de Administrador de Acesso de Usuário ou de outra função que inclua a Microsoft.Authorization/roleAssignments/write ação. Você pode atribuir funções do 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 Azure Service Bus Data Owner função à sua conta de usuário, que fornece acesso total aos recursos do Barramento de Serviço do Azure. Em um cenário real, siga o Princípio do Menor Privilégio 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 todos os recursos relacionados por meio do portal do Azure e da API de gerenciamento de recursos do Azure já está protegido usando o modelo RBAC do Azure. O Azure fornece as seguintes funções internas do Azure para autorizar o acesso a um namespace do Service Bus:

• Proprietário de Dados do Barramento de Serviço do Azure: habilita o acesso a dados ao namespace do Barramento de Serviço e suas entidades (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 conceder acesso de envio ao namespace do Barramento de Serviço e suas entidades.
• Recetor 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 necessários para operações do Service Bus.

Adicionar usuário do Microsoft Entra à função de Proprietário do Barramento de Serviço do Azure

Adicione seu nome de usuário do Microsoft Entra à função 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 da sua conta de usuário envie mensagens para uma fila ou um tópico e receba mensagens de uma fila ou da assinatura de um tópico.

Importante

Na maioria dos casos, levará um ou dois minutos para que a atribuição de função se propague no Azure. Em casos raros, pode demorar até oito minutos. Se você receber erros de autenticação quando executar o código pela primeira vez, aguarde alguns momentos e tente novamente.

1. Se você não tiver a página Namespace do Service Bus aberta no portal do Azure, localize seu namespace do Service Bus usando a barra de pesquisa principal ou a navegação à esquerda.

2. Na página de visão geral, selecione Controle de acesso (IAM) no menu à esquerda.

3. Na página Controle de acesso (IAM), selecione a guia Atribuições de função.

4. Selecione + Adicionar no menu superior e, em seguida, Adicionar atribuição de função no menu suspenso resultante.

   

5. Use a caixa de pesquisa para filtrar os resultados para a função desejada. Para este exemplo, procure Azure Service Bus Data Owner e selecione o resultado correspondente. Em seguida, escolha Avançar.

6. Em Atribuir acesso a, selecione Utilizador, grupo ou entidade de serviço e, em seguida, selecione + Selecionar membros.

7. Na caixa de diálogo, procure seu nome de usuário do Microsoft Entra (geralmente seu endereço de e-mail user@domain ) e escolha Selecionar na parte inferior da caixa de diálogo.

8. Selecione Rever + atribuir para ir para a página final e, em seguida , Rever + atribuir novamente para concluir o processo.

Cadeia de Ligação

Obter a cadeia de ligação

A criação de um novo namespace gera automaticamente uma política inicial de Assinatura de Acesso Compartilhado (SAS) com chaves primárias e secundárias e cadeias de conexão primárias e secundárias que concedem controle total sobre todos os aspetos do namespace. Consulte Autenticação e autorização do Service Bus para obter informações sobre como criar regras com direitos mais restritos para remetentes e destinatários regulares.

Um cliente pode usar a cadeia de conexão para se conectar ao namespace do Service Bus. Para copiar a cadeia de conexão primária para seu namespace, execute estas etapas:

1. Na página Namespace do Service Bus, selecione Políticas de acesso compartilhado no menu à esquerda.

2. Na página Políticas de acesso compartilhado, selecione RootManageSharedAccessKey.

3. Na janela Policy: RootManageSharedAccessKey, selecione o botão de cópia ao lado de Cadeia de conexão primária, para copiar a cadeia de conexão para a área de transferência para uso posterior. Cole este valor no Bloco de Notas ou noutra localização temporária.

   

   Você pode usar esta página para copiar chave primária, chave secundária, cadeia de conexão primária e cadeia de conexão secundária.

Use pip para instalar pacotes

Sem senha (recomendado)

1. Para instalar os pacotes Python necessários para este tutorial do Service Bus, abra um prompt de comando que tenha Python em seu caminho, altere o diretório para a pasta onde você deseja ter seus exemplos.

2. Instale os seguintes pacotes:

   pip install azure-servicebus
   pip install azure-identity
   pip install aiohttp
   

Cadeia de ligação

1. Para instalar os pacotes Python necessários para este tutorial do Service Bus, abra um prompt de comando que tenha Python em seu caminho, altere o diretório para a pasta onde você deseja ter seus exemplos.

2. Instale o seguinte pacote:

   pip install azure-servicebus
   

Enviar mensagens para uma fila

O código de exemplo a seguir mostra como enviar uma mensagem para uma fila. Abra seu editor favorito, como o Visual Studio Code, crie um send.py de arquivo e adicione o seguinte código a ele.

Sem senha (recomendado)

1. Adicione instruções de importação.

   import asyncio
   from azure.servicebus.aio import ServiceBusClient
   from azure.servicebus import ServiceBusMessage
   from azure.identity.aio import DefaultAzureCredential
   

2. Adicione constantes e defina uma credencial.

   FULLY_QUALIFIED_NAMESPACE = "FULLY_QUALIFIED_NAMESPACE"
   QUEUE_NAME = "QUEUE_NAME"
   
   credential = DefaultAzureCredential()
   

   Importante

   • Substitua FULLY_QUALIFIED_NAMESPACE pelo namespace totalmente qualificado para seu namespace do Service Bus.
   • Substitua QUEUE_NAME pelo nome da fila.

3. Adicione um método para enviar uma única mensagem.

   async def send_single_message(sender):
       # Create a Service Bus message and send it to the queue
       message = ServiceBusMessage("Single Message")
       await sender.send_messages(message)
       print("Sent a single message")
   

   O remetente é um objeto que atua como um cliente para a fila que você criou. Você irá criá-lo mais tarde e enviá-lo como um argumento para esta função.

4. Adicione um método para enviar uma lista de mensagens.

   async def send_a_list_of_messages(sender):
       # Create a list of messages and send it to the queue
       messages = [ServiceBusMessage("Message in list") for _ in range(5)]
       await sender.send_messages(messages)
       print("Sent a list of 5 messages")
   

5. Adicione um método para enviar um lote de mensagens.

   async def send_batch_message(sender):
       # Create a batch of messages
       async with sender:
           batch_message = await sender.create_message_batch()
           for _ in range(10):
               try:
                   # Add a message to the batch
                   batch_message.add_message(ServiceBusMessage("Message inside a ServiceBusMessageBatch"))
               except ValueError:
                   # ServiceBusMessageBatch object reaches max_size.
                   # New ServiceBusMessageBatch object can be created here to send more data.
                   break
           # Send the batch of messages to the queue
           await sender.send_messages(batch_message)
       print("Sent a batch of 10 messages")
   

6. Crie um cliente do Service Bus e, em seguida, um objeto de remetente de fila para enviar mensagens.

   async def run():
       # create a Service Bus client using the credential
       async with ServiceBusClient(
           fully_qualified_namespace=FULLY_QUALIFIED_NAMESPACE,
           credential=credential,
           logging_enable=True) as servicebus_client:
           # get a Queue Sender object to send messages to the queue
           sender = servicebus_client.get_queue_sender(queue_name=QUEUE_NAME)
           async with sender:
               # send one message
               await send_single_message(sender)
               # send a list of messages
               await send_a_list_of_messages(sender)
               # send a batch of messages
               await send_batch_message(sender)
   
           # Close credential when no longer needed.
           await credential.close()
   

7. Chame o run método e imprima uma mensagem.

   asyncio.run(run())
   print("Done sending messages")
   print("-----------------------")
   

Cadeia de ligação

1. Adicione instruções de importação.

   import asyncio
   from azure.servicebus.aio import ServiceBusClient
   from azure.servicebus import ServiceBusMessage
   

2. Adicione constantes.

   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STR"
   QUEUE_NAME = "QUEUE_NAME"
   

   Importante

   • Substitua NAMESPACE_CONNECTION_STR pela cadeia de conexão do namespace do Service Bus.
   • Substitua QUEUE_NAME pelo nome da fila.

3. Adicione um método para enviar uma única mensagem.

   async def send_single_message(sender):
       # Create a Service Bus message and send it to the queue
       message = ServiceBusMessage("Single Message")
       await sender.send_messages(message)
       print("Sent a single message")
   

   O remetente é um objeto que atua como um cliente para a fila que você criou. Você irá criá-lo mais tarde e enviá-lo como um argumento para esta função.

4. Adicione um método para enviar uma lista de mensagens.

   async def send_a_list_of_messages(sender):
       # Create a list of messages and send it to the queue
       messages = [ServiceBusMessage("Message in list") for _ in range(5)]
       await sender.send_messages(messages)
       print("Sent a list of 5 messages")
   

5. Adicione um método para enviar um lote de mensagens.

   async def send_batch_message(sender):
       # Create a batch of messages
       async with sender:
           batch_message = await sender.create_message_batch()
           for _ in range(10):
               try:
                   # Add a message to the batch
                   batch_message.add_message(ServiceBusMessage("Message inside a ServiceBusMessageBatch"))
               except ValueError:
                   # ServiceBusMessageBatch object reaches max_size.
                   # New ServiceBusMessageBatch object can be created here to send more data.
                   break
           # Send the batch of messages to the queue
           await sender.send_messages(batch_message)
       print("Sent a batch of 10 messages")
   

6. Crie um cliente do Service Bus e, em seguida, um objeto de remetente de fila para enviar mensagens.

   async def run():
       # create a Service Bus client using the connection string
       async with ServiceBusClient.from_connection_string(
           conn_str=NAMESPACE_CONNECTION_STR,
           logging_enable=True) as servicebus_client:
           # Get a Queue Sender object to send messages to the queue
           sender = servicebus_client.get_queue_sender(queue_name=QUEUE_NAME)
           async with sender:
               # Send one message
               await send_single_message(sender)
               # Send a list of messages
               await send_a_list_of_messages(sender)
               # Send a batch of messages
               await send_batch_message(sender)
   

7. Chame o run método e imprima uma mensagem.

   asyncio.run(run())
   print("Done sending messages")
   print("-----------------------")
   

Receber mensagens de uma fila

O código de exemplo a seguir mostra como receber mensagens de uma fila. O código mostrado recebe novas mensagens até não receber novas mensagens por 5 (max_wait_time) segundos.

Abra seu editor favorito, como o Visual Studio Code, crie um recv.py de arquivo e adicione o seguinte código a ele.

Sem senha (recomendado)

1. Semelhante ao exemplo de envio, adicione import instruções, defina constantes que você deve substituir por seus próprios valores e defina uma credencial.

   import asyncio
   
   from azure.servicebus.aio import ServiceBusClient
   from azure.identity.aio import DefaultAzureCredential
   
   FULLY_QUALIFIED_NAMESPACE = "FULLY_QUALIFIED_NAMESPACE"
   QUEUE_NAME = "QUEUE_NAME"
   
   credential = DefaultAzureCredential()
   

2. Crie um cliente do Service Bus e, em seguida, um objeto recetor de fila para receber mensagens.

   async def run():
       # create a Service Bus client using the connection string
       async with ServiceBusClient(
           fully_qualified_namespace=FULLY_QUALIFIED_NAMESPACE,
           credential=credential,
           logging_enable=True) as servicebus_client:
   
           async with servicebus_client:
               # get the Queue Receiver object for the queue
               receiver = servicebus_client.get_queue_receiver(queue_name=QUEUE_NAME)
               async with receiver:
                   received_msgs = await receiver.receive_messages(max_wait_time=5, max_message_count=20)
                   for msg in received_msgs:
                       print("Received: " + str(msg))
                       # complete the message so that the message is removed from the queue
                       await receiver.complete_message(msg)
   
           # Close credential when no longer needed.
           await credential.close()
   

3. Chame o run método.

   asyncio.run(run())
   

Cadeia de ligação

1. Semelhante ao exemplo de envio, adicione import instruções e defina constantes que você deve substituir por seus próprios valores.

   import asyncio
   from azure.servicebus.aio import ServiceBusClient
   
   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STR"
   QUEUE_NAME = "QUEUE_NAME"
   

2. Crie um cliente do Service Bus e, em seguida, um objeto recetor de fila para receber mensagens.

   async def run():
       # create a Service Bus client using the connection string
       async with ServiceBusClient.from_connection_string(
           conn_str=NAMESPACE_CONNECTION_STR,
           logging_enable=True) as servicebus_client:
   
           async with servicebus_client:
               # get the Queue Receiver object for the queue
               receiver = servicebus_client.get_queue_receiver(queue_name=QUEUE_NAME)
               async with receiver:
                   received_msgs = await receiver.receive_messages(max_wait_time=5, max_message_count=20)
                   for msg in received_msgs:
                       print("Received: " + str(msg))
                       # complete the message so that the message is removed from the queue
                       await receiver.complete_message(msg)
   

3. Chame o run método.

   asyncio.run(run())
   

Executar a aplicação

Abra um prompt de comando que tenha Python em seu caminho e, em seguida, execute o código para enviar e receber mensagens da fila.

python send.py; python recv.py

Deverá ver o seguinte resultado:

Sent a single message
Sent a list of 5 messages
Sent a batch of 10 messages
Done sending messages
-----------------------
Received: Single Message
Received: Message in list
Received: Message in list
Received: Message in list
Received: Message in list
Received: Message in list
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch
Received: Message inside a ServiceBusMessageBatch

No portal do Azure, navegue até o namespace do Service Bus. Na página Visão geral, verifique se as contagens de mensagens de entrada e saída são 16. Se não vir as contagens, atualize a página depois de aguardar alguns minutos.

Selecione a fila nesta página Visão geral para navegar até a página Fila do Service Bus. Você também pode ver a contagem de mensagens recebidas e enviadas nesta página. Você também verá outras informações, como o tamanho atual da fila e a contagem de mensagens ativas.

Próximos passos

Consulte a seguinte documentação e exemplos:

• Biblioteca de cliente do Azure Service Bus para Python
• Exemplos.
  • A pasta sync_samples tem exemplos que mostram como interagir com o Service Bus de maneira síncrona.
  • A pasta async_samples tem exemplos que mostram como interagir com o Service Bus de forma assíncrona. Neste início rápido, você usou esse método.
• Documentação de referência do Azure-ServiceBus