Quickstart: Berichten verzenden naar en ontvangen van Azure Service Bus-wachtrijen (Python)

Ga als volgt te werk om deze quickstart te gebruiken met uw eigen Azure-account:

• Installeer Azure CLI, dat de verificatie zonder wachtwoord biedt voor uw ontwikkelcomputer.
• Meld u aan met uw Azure-account bij de terminal of opdrachtprompt met az login.
• Gebruik hetzelfde account wanneer u de juiste gegevensrol aan uw resource toevoegt.
• Voer de code uit in dezelfde terminal of opdrachtprompt.
• Noteer de wachtrijnaam voor uw Service Bus-naamruimte. Je hebt dat nodig in de code.

Let op de volgende waarden die u in de code gebruikt:

• Service Bus-naamruimte verbindingsreeks
• Service Bus-naamruimtewachtrij die u hebt gemaakt

Rollen toewijzen aan uw Microsoft Entra-gebruiker

Wanneer u lokaal ontwikkelt, moet u ervoor zorgen dat het gebruikersaccount dat verbinding maakt met Azure Service Bus de juiste machtigingen heeft. U hebt de rol Azure Service Bus-gegevenseigenaar nodig om berichten te kunnen verzenden en ontvangen. Als u uzelf deze rol wilt toewijzen, hebt u de rol Gebruikerstoegangsbeheerder of een andere rol nodig die de Microsoft.Authorization/roleAssignments/write actie bevat.

U kunt Azure RBAC-rollen toewijzen aan een gebruiker met behulp van Azure Portal, Azure CLI of Azure PowerShell. Zie Bereik voor Azure RBAC begrijpen voor meer informatie over de beschikbare bereiken voor roltoewijzingen.

In het volgende voorbeeld wordt de Azure Service Bus Data Owner rol toegewezen aan uw gebruikersaccount, dat volledige toegang biedt tot Azure Service Bus-resources. Volg in een echt scenario het principe van minimale bevoegdheden om gebruikers alleen de minimale machtigingen te geven die nodig zijn voor een veiligere productieomgeving.

Ingebouwde Azure-rollen voor Azure Service Bus

Voor Azure Service Bus is het beheer van naamruimten en alle gerelateerde resources via Azure Portal en de Azure Resource Management-API al beveiligd met behulp van het Azure RBAC-model. Azure biedt de volgende ingebouwde Azure-rollen voor het autoriseren van toegang tot een Service Bus-naamruimte:

• Azure Service Bus-gegevenseigenaar: hiermee schakelt u gegevenstoegang tot de Service Bus-naamruimte en de bijbehorende entiteiten in, waaronder wachtrijen, onderwerpen, abonnementen en filters. Een lid van deze rol kan berichten verzenden en ontvangen van wachtrijen of onderwerpen/abonnementen.
• Azure Service Bus-gegevenszender: gebruik deze rol om de toegang te verlenen tot de Service Bus-naamruimte en de send bijbehorende entiteiten.
• Azure Service Bus-gegevensontvanger: gebruik deze rol om de toegang te verlenen tot de Service Bus-naamruimte en de receive bijbehorende entiteiten.

Als u een aangepaste rol wilt maken, raadpleegt u Rechten die vereist zijn voor Service Bus-bewerkingen.

Microsoft Entra-gebruiker toevoegen aan de rol Azure Service Bus-eigenaar

Voeg uw Microsoft Entra-gebruikersnaam toe aan de rol Azure Service Bus-gegevenseigenaar op het niveau van de Service Bus-naamruimte. Met deze configuratie kan een app die wordt uitgevoerd in de context van uw gebruikersaccount berichten verzenden naar een wachtrij of een onderwerp. Het kan berichten ontvangen van een wachtrij of een abonnement op een onderwerp.

1. Als u de pagina Service Bus-naamruimte niet hebt geopend in Azure Portal, zoekt u uw Service Bus-naamruimte met behulp van de hoofdzoekbalk of linkernavigatiebalk.

2. Selecteer op de pagina Overzichttoegangsbeheer (IAM) in het menu aan de linkerkant.

3. Selecteer op de pagina Toegangsbeheer (IAM) het tabblad Roltoewijzingen .

4. Selecteer + Toevoegen in het bovenste menu en voeg vervolgens roltoewijzing toe.

   

5. Gebruik het zoekvak om de resultaten te filteren op de gewenste rol. In dit voorbeeld zoekt Azure Service Bus Data Owner en selecteert u het overeenkomende resultaat. Kies vervolgens Volgende.

6. Selecteer onder Toegang toewijzen de optie Gebruiker, groep of service-principal en kies vervolgens + Leden selecteren.

7. Zoek in het dialoogvenster naar uw Microsoft Entra-gebruikersnaam (meestal uw user@domain e-mailadres) en kies Vervolgens onderaan het dialoogvenster Selecteren .

8. Selecteer Beoordelen + toewijzen om naar de laatste pagina te gaan en vervolgens opnieuw beoordelen en toewijzen om het proces te voltooien.

De verbindingsreeks ophalen

Als u een nieuwe naamruimte maakt, wordt automatisch een eerste SAS-beleid (Shared Access Signature) gegenereerd met primaire en secundaire sleutels. Hiermee worden primaire en secundaire verbindingsreeksen gemaakt die elk volledige controle over alle aspecten van de naamruimte verlenen. Zie Service Bus-verificatie en -autorisatie voor meer informatie over het maken van regels met meer beperkte rechten voor reguliere afzenders en ontvangers.

Een client kan de verbindingsreeks gebruiken om verbinding te maken met de Service Bus-naamruimte. Voer de volgende stappen uit om de primaire verbindingsreeks voor uw naamruimte te kopiëren:

1. Vouw op de pagina Service Bus-naamruimte in het linkermenu Instellingen uit en selecteer vervolgens Beleid voor gedeelde toegang.

2. Selecteer RootManageSharedAccessKey op de pagina Beleid voor gedeelde toegang.

3. Selecteer in het venster Beleid: RootManageSharedAccessKey de knop Kopiëren naast primaire verbindingsreeks om de verbindingsreeks naar het klembord te kopiëren voor later gebruik. Plak deze waarde in Kladblok of een andere tijdelijke locatie.

   

   U kunt deze pagina gebruiken om de primaire sleutel, secundaire sleutel, primaire verbindingsreeks en secundaire verbindingsreeks te kopiëren.

1. Als u de vereiste Python-pakketten voor deze Service Bus-quickstart wilt installeren, opent u een opdrachtpromptvenster met Python in het pad.

2. Wijzig de map in de map waarin u uw voorbeelden wilt hebben.

3. Installeer de volgende pakketten:

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

1. Als u de vereiste Python-pakketten voor deze Service Bus-quickstart wilt installeren, opent u een opdrachtpromptvenster met Python in het pad.

2. Wijzig de map in de map waarin u uw voorbeelden wilt hebben.

3. Installeer het volgende pakket:

   pip install azure-servicebus
   

1. Importinstructies toevoegen.

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

2. Voeg constanten toe en definieer een referentie.

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

   Belangrijk

   • Vervang door FULLY_QUALIFIED_NAMESPACE de volledig gekwalificeerde naamruimte voor uw Service Bus-naamruimte.
   • Vervang QUEUE_NAME door de naam van het wachtrij.

3. Voeg een methode voor het verzenden van één bericht toe.

   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")
   

   De afzender is een object dat fungeert als een client voor de wachtrij dat u hebt gemaakt. U maakt deze later en verzendt als argument naar deze functie.

4. Voeg een methode voor het verzenden van een lijst met berichten toe.

   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. Voeg een methode voor het verzenden van een batch met berichten toe.

   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. Maak een Service Bus-client en vervolgens een object voor de afzender van de wachtrij om berichten te verzenden.

   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. Roep de run methode aan en druk een bericht af.

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

1. Importinstructies toevoegen.

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

2. Voeg constanten toe.

   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STR"
   QUEUE_NAME = "QUEUE_NAME"
   

   Belangrijk

   • Vervang NAMESPACE_CONNECTION_STR door de verbindingstekenreeks voor uw Service Bus-naamruimte.
   • Vervang QUEUE_NAME door de naam van het wachtrij.

3. Voeg een methode voor het verzenden van één bericht toe.

   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")
   

   De afzender is een object dat fungeert als een client voor de wachtrij dat u hebt gemaakt. U maakt deze later en verzendt als argument naar deze functie.

4. Voeg een methode voor het verzenden van een lijst met berichten toe.

   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. Voeg een methode voor het verzenden van een batch met berichten toe.

   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. Maak een Service Bus-client en vervolgens een object voor de afzender van de wachtrij om berichten te verzenden.

   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. Roep de run methode aan en druk een bericht af.

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

1. Voeg instructies toe die vergelijkbaar zijn met het import. Vervang de constanten door uw eigen waarden en definieer een referentie.

   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. Maak een Service Bus-client en vervolgens een wachtrijontvangerobject om berichten te ontvangen.

   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. Roep de run methode aan.

   asyncio.run(run())
   

1. Net als bij het send.py voorbeeld voegt u instructies toe import en definieert u constanten die uw eigen waarden gebruiken.

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

2. Maak een Service Bus-client en vervolgens een wachtrijontvangerobject om berichten te ontvangen.

   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. Roep de run methode aan.

   asyncio.run(run())