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

• C#
• Java
• JavaScript
• Python

I den här självstudien gör du följande:

1. Skapa ett Service Bus-namnområde med Azure Portal.
2. Skapa en Service Bus-kö med Azure Portal.
3. Skriv Python-kod för att använda azure-servicebus-paketet för att:
   1. Skicka en uppsättning meddelanden till kön.
   2. Ta emot dessa meddelanden från kön.

Kommentar

Den här snabbstarten innehåller stegvisa instruktioner för ett enkelt scenario med att skicka meddelanden till en Service Bus-kö och ta emot dem. Du hittar fördefinierade JavaScript- och TypeScript-exempel för Azure Service Bus i Azure SDK för Python-lagringsplatsen på GitHub.

Förutsättningar

Om du är nybörjare på tjänsten kan du läsa Översikt över Service Bus innan du gör den här snabbstarten.

• En Azure-prenumeration Du behöver ett Azure-konto för att slutföra den här självstudien. Du kan aktivera dina MSDN-prenumerantförmåner eller registrera dig för ett kostnadsfritt konto.

• Python 3.8 eller senare.

Lösenordsfri (rekommenderas)

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.

Anslutningssträng

Observera följande, som du använder i koden nedan:

• Service Bus-namnområde niska veze
• Service Bus-namnområdeskö som du skapade

Kommentar

Den här självstudien fungerar med exempel som du kan kopiera och köra med Python. Anvisningar om hur du skapar ett Python-program finns i Skapa och distribuera ett Python-program till en Azure-webbplats. Mer information om hur du installerar paket som används i den här självstudien finns i Python-installationsguiden.

Skapa ett namnområde i Azure Portal

För att komma igång med Service Bus-meddelandeentiteter i Azure måste du först skapa ett namnområde med ett namn som är unikt i Azure. Ett namnområde tillhandahåller en omfångscontainer för Service Bus-resurser (köer, ämnen osv.) i ditt program.

Så här skapar du ett namnområde:

1. Logga in på Azure-portalen.

2. Gå till sidan Alla tjänster.

3. I det vänstra navigeringsfältet väljer du Integrering i listan över kategorier, hovra musen över Service Bus och välj + sedan knappen på Service Bus-panelen.

   

4. Följ dessa steg i taggen Grundläggande på sidan Skapa namnområde:

   1. För Prenumeration väljer du en Azure-prenumeration där du ska skapa namnrymden.

   2. För Resursgrupp väljer du en befintlig resursgrupp där namnrymden ska finnas, eller så skapar du en ny.

   3. Ange ett namn för namnrymden. Namnområdesnamnet bör följa följande namngivningskonventioner:

      • Namnet måste vara unikt i Hela Azure. Systemet kontrollerar omedelbart om namnet är tillgängligt.
      • Namnlängden är minst 6 och högst 50 tecken.
      • Namnet får endast innehålla bokstäver, siffror, bindestreck "-".
      • Namnet måste börja med en bokstav och sluta med en bokstav eller siffra.
      • Namnet slutar inte med "-sb" eller "-mgmt".

   4. För Plats väljer du land eller region där namnrymden ska finnas.

   5. För Prisnivå väljer du prisnivån (Basic, Standard eller Premium) för namnområdet. För den här snabbstarten väljer du Standard.

      Viktigt!

      Om du vill använda ämnen och prenumerationer väljer du antingen Standard eller Premium. Ämnen/prenumerationer stöds inte på prisnivån Basic.

      Om du har valt prisnivån Premium anger du antalet meddelandeenheter. Premium-nivån ger resursisolering på processor- och minnesnivå så att varje arbetsbelastning körs självständigt. Den här resurscontainern kallas för en meddelandefunktionsenhet. Ett premiumnamnområde har minst en meddelandeenhet. Du kan välja 1, 2, 4, 8 eller 16 meddelandeenheter för varje Service Bus Premium-namnområde. Mer information finns i Service Bus Premium-meddelanden.

   6. Välj Granska + skapa längst ned på sidan.

      

   7. På sidan Granska + skapa granskar du inställningarna och väljer Skapa.

5. När distributionen av resursen har slutförts väljer du Gå till resurs på distributionssidan.

   

6. Startsidan för din Service Bus-namnrymd visas.

   

Skapa en kö i Azure-portalen

1. På sidan Service Bus Namespace (Service Bus-namnrymd) väljer du Köer på navigeringsmenyn till vänster.

2. På sidan Köer väljer du + Kö i verktygsfältet.

3. Ange ett namn för kön och låt de andra värdena ha kvar standardvärdena.

4. Välj nu Skapa.

   

Autentisera appen till Azure

Den här snabbstarten visar två sätt att ansluta till Azure Service Bus: lösenordsfri och niska veze.

Det första alternativet visar hur du använder ditt säkerhetsobjekt i Microsoft Entra-ID och rollbaserad åtkomstkontroll (RBAC) för att ansluta till ett Service Bus-namnområde. Du behöver inte oroa dig för att ha hårdkodade niska veze i koden eller i en konfigurationsfil eller i ett säkert lagringsutrymme som Azure Key Vault.

Det andra alternativet visar hur du använder en niska veze för att ansluta till ett Service Bus-namnområde. Om du inte har använt Azure tidigare kan det vara enklare att följa niska veze alternativet. Vi rekommenderar att du använder det lösenordslösa alternativet i verkliga program och produktionsmiljöer. Mer information finns i Autentisering och auktorisering. Du kan också läsa mer om lösenordslös autentisering på översiktssidan.

Lösenordsfri (rekommenderas)

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-portalen, Azure CLI eller Azure PowerShell. Läs mer om tillgängliga omfång för rolltilldelningar på översiktssidan för omfång .

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 lägsta 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-portalen och Azure-resurshanterings-API:et med hjälp av Azure RBAC-modellen. Azure tillhandahåller de inbyggda Azure-rollerna nedan 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 (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 Data Sender: Använd den här rollen för att ge sändningsåtkomst till Service Bus-namnområdet och dess entiteter.
• Azure Service Bus-datamottagare: Använd den här rollen för att ge ta emot å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å. Det gör att en app som körs i kontexten för ditt användarkonto kan skicka meddelanden till en kö eller ett ämne och ta emot meddelanden från en kö eller ett ämnes prenumeration.

Viktigt!

I de flesta fall tar det en minut eller två innan rolltilldelningen sprids i Azure. I sällsynta fall kan det ta upp till åtta minuter. Om du får autentiseringsfel när du först kör koden väntar du en stund och försöker igen.

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

2. På översiktssidan 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 från den resulterande nedrullningsbara menyn.

   

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.

Anslutningssträng

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 och primära och sekundära niska veze som var och en ger fullständig kontroll över alla aspekter av namnområdet. Se Service Bus – autentisering och auktorisering för mer information om hur du skapar regler med mer begränsade rättigheter för regelbundna sändare och mottagare.

En klient kan använda niska veze för att ansluta till Service Bus-namnområdet. Följ dessa steg för att kopiera den primära niska veze för ditt namnområde:

1. På sidan Service Bus-namnområde väljer du Principer för delad åtkomst på den vänstra menyn.

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 niska veze 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 niska veze och sekundär niska veze.

Använda pip för att installera paket

Lösenordsfri (rekommenderas)

1. Om du vill installera nödvändiga Python-paket för den här Service Bus-självstudien öppnar du en kommandotolk som har Python i sin sökväg, ändrar katalogen till den mapp där du vill ha dina exempel.

2. Installera följande paket:

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

Anslutningssträng

1. Om du vill installera nödvändiga Python-paket för den här Service Bus-självstudien öppnar du en kommandotolk som har Python i sin sökväg, ändrar katalogen till den mapp där du vill ha dina exempel.

2. Installera följande paket:

   pip install azure-servicebus
   

Skicka meddelanden till en kö

Följande exempelkod visar hur du skickar ett meddelande till en kö. Öppna din favoritredigerare, till exempel Visual Studio Code, skapa en fil send.py och lägg till följande kod i den.

Lösenordsfri (rekommenderas)

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

Anslutningssträng

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 niska veze 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("-----------------------")
   

Ta emot meddelanden från en kö

Följande exempelkod visar hur du tar emot meddelanden från en kö. Koden som visas tar emot nya meddelanden tills den inte tar emot några nya meddelanden på 5 (max_wait_time) sekunder.

Öppna din favoritredigerare, till exempel Visual Studio Code, skapa en fil recv.py och lägg till följande kod i den.

Lösenordsfri (rekommenderas)

1. Precis som i skicka-exemplet lägger du till import instruktioner, definierar konstanter som du bör ersätta med dina egna värden och definierar 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())
   

Anslutningssträng

1. På samma sätt som i skicka-exemplet lägger du till import instruktioner och definierar konstanter som du bör ersätta med 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())
   

Kör appen

Öppna en kommandotolk som har Python i sökvägen och kör sedan koden för att skicka och ta emot meddelanden från kön.

python send.py; python recv.py

Du bör se följande utdata:

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

Gå till Service Bus-namnområdet i Azure-portalen. På sidan Översikt kontrollerar du att antalet inkommande och utgående meddelanden är 16. Om du inte ser antalet uppdaterar du sidan efter att ha väntat i några minuter.

Välj kön på den här översiktssidan för att gå till sidan Service Bus-kö . Du kan också se antalet inkommande och utgående meddelanden på den här sidan. Du ser även annan information, till exempel köns aktuella storlek och antalet aktiva meddelanden.

Nästa steg

Se följande dokumentation och exempel:

• Azure Service Bus-klientbibliotek för Python
• Exempel.
  • Mappen sync_samples innehåller exempel som visar hur du interagerar med Service Bus på ett synkront sätt.
  • Mappen async_samples innehåller exempel som visar hur du interagerar med Service Bus på ett asynkront sätt. I den här snabbstarten använde du den här metoden.
• referensdokumentation för azure-servicebus