Snabbstart: Skicka meddelanden till och ta emot meddelanden från Azure Service Bus-köer (Python)

Så här använder du den här snabbstarten med ditt eget Azure-konto:

• Installera Azure CLI, som tillhandahåller lösenordslös autentisering till utvecklardatorn.
• Logga in med ditt Azure-konto i terminalen eller kommandotolken med az login.
• Använd samma konto när du lägger till lämplig dataroll i resursen.
• Kör koden i samma terminal eller kommandotolk.
• Observera könamnet för Service Bus-namnområdet. Du behöver det i koden.

Observera följande värden som du använder i koden:

• Service Bus-namnområde anslutningssträng
• Service Bus-namnområdeskö som du skapade

Tilldela roller till din Microsoft Entra-användare

När du utvecklar lokalt kontrollerar du att användarkontot som ansluter till Azure Service Bus har rätt behörigheter. Du behöver rollen Azure Service Bus-dataägare för att kunna skicka och ta emot meddelanden. Om du vill tilldela dig själv den här rollen behöver du rollen Administratör för användaråtkomst eller en annan roll som innehåller åtgärden Microsoft.Authorization/roleAssignments/write .

Du kan tilldela Azure RBAC-roller till en användare med hjälp av Azure Portal, Azure CLI eller Azure PowerShell. Mer information om tillgängliga omfång för rolltilldelningar finns i Förstå omfånget för Azure RBAC.

I följande exempel tilldelas Azure Service Bus Data Owner rollen till ditt användarkonto, vilket ger fullständig åtkomst till Azure Service Bus-resurser. I ett verkligt scenario följer du principen om minsta behörighet för att ge användarna endast de minsta behörigheter som krävs för en säkrare produktionsmiljö.

Inbyggda Azure-roller för Azure Service Bus

För Azure Service Bus skyddas redan hanteringen av namnområden och alla relaterade resurser via Azure Portal och Azure-resurshanterings-API:et med hjälp av Azure RBAC-modellen. Azure tillhandahåller följande inbyggda Azure-roller för att auktorisera åtkomst till ett Service Bus-namnområde:

• Azure Service Bus-dataägare: Ger dataåtkomst till Service Bus-namnområdet och dess entiteter, inklusive köer, ämnen, prenumerationer och filter. En medlem i den här rollen kan skicka och ta emot meddelanden från köer eller ämnen/prenumerationer.
• Azure Service Bus-datasändare: Använd den här rollen för att ge send åtkomst till Service Bus-namnområdet och dess entiteter.
• Azure Service Bus-datamottagare: Använd den receive här rollen för att ge åtkomst till Service Bus-namnområdet och dess entiteter.

Om du vill skapa en anpassad roll läser du Rättigheter som krävs för Service Bus-åtgärder.

Lägga till Microsoft Entra-användare i rollen Som Azure Service Bus-ägare

Lägg till ditt Microsoft Entra-användarnamn i rollen Azure Service Bus-dataägare på Service Bus-namnområdesnivå. Med den här konfigurationen kan en app som körs i kontexten för ditt användarkonto skicka meddelanden till en kö eller ett ämne. Den kan ta emot meddelanden från en kö eller ett ämnesprenumeration.

1. Om du inte har sidan Service Bus-namnområde öppen i Azure Portal letar du upp Service Bus-namnområdet med hjälp av huvudsökfältet eller det vänstra navigeringsfältet.

2. På sidan Översikt väljer du Åtkomstkontroll (IAM) på den vänstra menyn.

3. På sidan Åtkomstkontroll (IAM) väljer du fliken Rolltilldelningar .

4. Välj + Lägg till på den översta menyn och sedan Lägg till rolltilldelning.

   

5. Använd sökrutan för att filtrera resultatet till önskad roll. I det här exemplet söker Azure Service Bus Data Owner du efter och väljer matchande resultat. Välj sedan Nästa.

6. Under Tilldela åtkomst till väljer du Användare, grupp eller tjänstens huvudnamn och sedan + Välj medlemmar.

7. I dialogrutan söker du efter ditt Microsoft Entra-användarnamn (vanligtvis din user@domain e-postadress) och väljer sedan Välj längst ned i dialogrutan.

8. Välj Granska + tilldela för att gå till den sista sidan och sedan Granska + tilldela igen för att slutföra processen.

Hämta anslutningssträngen

När du skapar ett nytt namnområde genereras automatiskt en inledande SAS-princip (Signatur för delad åtkomst) med primära och sekundära nycklar. Den skapar primära och sekundära anslutningssträngar som var och en ger fullständig kontroll över alla aspekter av namnområdet. Mer information om hur du skapar regler med mer begränsade rättigheter för vanliga avsändare och mottagare finns i Service Bus-autentisering och auktorisering.

En klient kan använda anslutningssträng för att ansluta till Service Bus-namnområdet. Så här kopierar du den primära anslutningssträng för ditt namnområde:

1. På sidan Service Bus-namnområde går du till den vänstra menyn och expanderar Inställningar och väljer sedan Principer för delad åtkomst.

2. På sidan Principer för delad åtkomst väljer du RootManageSharedAccessKey.

3. I fönstret Princip: RootManageSharedAccessKey väljer du kopieringsknappen bredvid Primär anslutningssträng för att kopiera anslutningssträng till Urklipp för senare användning. Klistra in det här värdet i Anteckningar eller på en tillfällig plats.

   

   Du kan använda den här sidan för att kopiera primärnyckel, sekundär nyckel, primär anslutningssträng och sekundär anslutningssträng.

1. Om du vill installera nödvändiga Python-paket för den här Service Bus-snabbstarten öppnar du ett kommandotolkfönster som har Python i sin sökväg.

2. Ändra katalogen till den mapp där du vill ha dina exempel.

3. Installera följande paket:

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

1. Om du vill installera nödvändiga Python-paket för den här Service Bus-snabbstarten öppnar du ett kommandotolkfönster som har Python i sin sökväg.

2. Ändra katalogen till den mapp där du vill ha dina exempel.

3. Installera följande paket:

   pip install azure-servicebus
   

1. Lägg till importinstruktioner.

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

2. Lägg till konstanter och definiera en autentiseringsuppgift.

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

   Viktigt!

   • Ersätt FULLY_QUALIFIED_NAMESPACE med det fullständigt kvalificerade namnområdet för Service Bus-namnområdet.
   • Ersätt QUEUE_NAME med namnet på kön.

3. Lägg till en metod för att skicka ett enda meddelande.

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

   Avsändaren är ett objekt som fungerar som en klient för kön som du skapade. Du skapar den senare och skickar den som ett argument till den här funktionen.

4. Lägg till en metod för att skicka en lista med meddelanden.

   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. Lägg till en metod för att skicka en batch med meddelanden.

   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. Skapa en Service Bus-klient och sedan ett kösändarobjekt för att skicka meddelanden.

   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. run Anropa metoden och skriv ut ett meddelande.

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

1. Lägg till importinstruktioner.

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

2. Lägg till konstanter.

   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STR"
   QUEUE_NAME = "QUEUE_NAME"
   

   Viktigt!

   • Ersätt NAMESPACE_CONNECTION_STR med anslutningssträng för Service Bus-namnområdet.
   • Ersätt QUEUE_NAME med namnet på kön.

3. Lägg till en metod för att skicka ett enda meddelande.

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

   Avsändaren är ett objekt som fungerar som en klient för kön som du skapade. Du skapar den senare och skickar den som ett argument till den här funktionen.

4. Lägg till en metod för att skicka en lista med meddelanden.

   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. Lägg till en metod för att skicka en batch med meddelanden.

   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. Skapa en Service Bus-klient och sedan ett kösändarobjekt för att skicka meddelanden.

   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. run Anropa metoden och skriv ut ett meddelande.

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

1. På samma sätt som i send.py exempel lägger du till import instruktioner. Ersätt konstanterna med dina egna värden och definiera en autentiseringsuppgift.

   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. Skapa en Service Bus-klient och sedan ett kömottagareobjekt för att ta emot meddelanden.

   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. run Anropa metoden.

   asyncio.run(run())
   

1. På samma sätt som i exemplet send.py lägger du till import instruktioner och definierar konstanter som använder dina egna värden.

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

2. Skapa en Service Bus-klient och sedan ett kömottagareobjekt för att ta emot meddelanden.

   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. run Anropa metoden.

   asyncio.run(run())