Wysyłanie komunikatów do tematu usługi Azure Service Bus i odbieranie komunikatów z subskrypcji do tematu (Python)

Przypisywanie ról do użytkownika firmy Microsoft Entra

Podczas tworzenia aplikacji lokalnie upewnij się, że konto użytkownika, które nawiązuje połączenie z usługą Azure Service Bus, ma odpowiednie uprawnienia. Aby wysyłać i odbierać komunikaty, musisz mieć rolę Właściciela danych usługi Azure Service Bus. Aby przypisać sobie tę rolę, musisz mieć rolę Administracja istratora dostępu użytkowników lub inną rolę obejmującą Microsoft.Authorization/roleAssignments/write akcję. Role RBAC platformy Azure można przypisać użytkownikowi przy użyciu witryny Azure Portal, interfejsu wiersza polecenia platformy Azure lub programu Azure PowerShell. Dowiedz się więcej o dostępnych zakresach przypisań ról na stronie przeglądu zakresu.

Poniższy przykład przypisuje Azure Service Bus Data Owner rolę do konta użytkownika, co zapewnia pełny dostęp do zasobów usługi Azure Service Bus. W rzeczywistym scenariuszu postępuj zgodnie z zasadą najniższych uprawnień , aby dać użytkownikom tylko minimalne uprawnienia wymagane do bezpieczniejszego środowiska produkcyjnego.

Wbudowane role platformy Azure dla usługi Azure Service Bus

W przypadku usługi Azure Service Bus zarządzanie przestrzeniami nazw i wszystkimi powiązanymi zasobami za pośrednictwem witryny Azure Portal i interfejsu API zarządzania zasobami platformy Azure jest już chronione przy użyciu modelu RBAC platformy Azure. Platforma Azure udostępnia poniższe wbudowane role platformy Azure umożliwiające autoryzowanie dostępu do przestrzeni nazw usługi Service Bus:

• Właściciel danych usługi Azure Service Bus: umożliwia dostęp danych do przestrzeni nazw usługi Service Bus i jej jednostek (kolejek, tematów, subskrypcji i filtrów). Członek tej roli może wysyłać i odbierać komunikaty z kolejek lub tematów/subskrypcji.
• Nadawca danych usługi Azure Service Bus: użyj tej roli, aby udzielić dostępu do przestrzeni nazw usługi Service Bus i jej jednostek.
• Odbiornik danych usługi Azure Service Bus: ta rola umożliwia uzyskiwanie dostępu do przestrzeni nazw usługi Service Bus i jej jednostek.

Jeśli chcesz utworzyć rolę niestandardową, zobacz Prawa wymagane dla operacji usługi Service Bus.

Dodawanie użytkownika usługi Microsoft Entra do roli właściciela usługi Azure Service Bus

Dodaj nazwę użytkownika usługi Microsoft Entra do roli właściciela danych usługi Azure Service Bus na poziomie przestrzeni nazw usługi Service Bus. Umożliwi to aplikacji działającej w kontekście konta użytkownika wysyłanie komunikatów do kolejki lub tematu oraz odbieranie komunikatów z kolejki lub subskrypcji tematu.

1. Jeśli nie masz otwartej strony przestrzeni nazw usługi Service Bus w witrynie Azure Portal, znajdź przestrzeń nazw usługi Service Bus przy użyciu głównego paska wyszukiwania lub nawigacji po lewej stronie.

2. Na stronie przeglądu wybierz pozycję Kontrola dostępu (Zarządzanie dostępem i tożsamościami) z menu po lewej stronie.

3. Na stronie Kontrola dostępu (Zarządzanie dostępem i tożsamościami) wybierz kartę Przypisania ról.

4. Wybierz pozycję + Dodaj z górnego menu, a następnie pozycję Dodaj przypisanie roli z wyświetlonego menu rozwijanego.

   

5. Użyj pola wyszukiwania, aby filtrować wyniki do żądanej roli. W tym przykładzie wyszukaj Azure Service Bus Data Owner i wybierz pasujący wynik. Następnie wybierz pozycję Dalej.

6. W obszarze Przypisz dostęp do wybierz pozycję Użytkownik, grupa lub jednostka usługi, a następnie wybierz pozycję + Wybierz członków.

7. W oknie dialogowym wyszukaj nazwę użytkownika firmy Microsoft Entra (zazwyczaj adres e-mail user@domain ), a następnie wybierz pozycję Wybierz w dolnej części okna dialogowego.

8. Wybierz pozycję Przejrzyj i przypisz , aby przejść do ostatniej strony, a następnie ponownie przejrzyj i przypisz, aby ukończyć proces.

Pobieranie parametrów połączenia

Utworzenie nowej przestrzeni nazw automatycznie generuje początkowe zasady sygnatury dostępu współdzielonego (SAS) z kluczami podstawowymi i pomocniczymi oraz podstawowymi i pomocniczymi parametry połączenia, które zapewniają pełną kontrolę nad wszystkimi aspektami przestrzeni nazw. Zapoznaj się z artykułem Uwierzytelnianie i autoryzacja w usłudze Service Bus, aby dowiedzieć się, jak utworzyć reguły z bardziej ograniczonymi prawami dla zwykłych nadawców i odbiorców.

Klient może użyć parametry połączenia do nawiązania połączenia z przestrzenią nazw usługi Service Bus. Aby skopiować parametry połączenia podstawową dla przestrzeni nazw, wykonaj następujące kroki:

1. Na stronie Przestrzeń nazw usługi Service Bus wybierz pozycję Zasady dostępu współdzielonego w menu po lewej stronie.

2. Na stronie Zasady dostępu współdzielonego wybierz pozycję RootManageSharedAccessKey.

3. W oknie Zasady: RootManageSharedAccessKey wybierz przycisk kopiowania obok pozycji Podstawowy ciąg Połączenie ion, aby skopiować parametry połączenia do schowka do późniejszego użycia. Wklej tę wartość do Notatnika lub innej tymczasowej lokalizacji.

   

   Ta strona służy do kopiowania klucza podstawowego, klucza pomocniczego, parametry połączenia podstawowego i pomocniczego parametry połączenia.

Aby wykonać czynności opisane w tym przewodniku Szybki start, użyj uwierzytelniania bez hasła i własnego konta platformy Azure:

• Zainstaluj interfejs wiersza polecenia platformy Azure.
• Zaloguj się przy użyciu konta platformy Azure w terminalu lub wierszu polecenia za pomocą polecenia az login.
• Użyj tego samego konta podczas dodawania odpowiedniej roli do zasobu w dalszej części samouczka.
• Uruchom kod samouczka w tym samym terminalu lub wierszu polecenia.

Aby użyć kodu bez hasła, należy określić:

• w pełni kwalifikowana przestrzeń nazw usługi Service Bus, na przykład: <service-bus-namespace.servicebus.windows.net>
• nazwa tematu
• Nazwa subskrypcji

Aby wykonać czynności opisane w tym przewodniku Szybki start przy użyciu parametry połączenia do uwierzytelniania, nie używasz własnego konta platformy Azure. Zamiast tego użyjesz parametry połączenia dla przestrzeni nazw usługi Service Bus.

Aby użyć kodu połączenia, należy określić:

• parametry połączenia
• nazwa tematu
• Nazwa subskrypcji

1. Aby zainstalować wymagane pakiety języka Python na potrzeby tego samouczka usługi Service Bus, otwórz wiersz polecenia z językiem Python w swojej ścieżce. Zmień katalog na folder, w którym chcesz mieć przykłady.

2. Instalowanie pakietów:

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

1. Aby zainstalować wymagane pakiety języka Python na potrzeby tego samouczka usługi Service Bus, otwórz wiersz polecenia z językiem Python w swojej ścieżce. Zmień katalog na folder, w którym chcesz mieć przykłady.

2. Zainstaluj pakiet:

   pip install azure-servicebus
   

1. Dodaj następujące instrukcje import.

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

2. Dodaj stałe i zdefiniuj poświadczenia.

   FULLY_QUALIFIED_NAMESPACE = "FULLY_QUALIFIED_NAMESPACE"
   TOPIC_NAME = "TOPIC_NAME"
   
   credential = DefaultAzureCredential()
   

   Ważne

   • Zastąp FULLY_QUALIFIED_NAMESPACE element w pełni kwalifikowaną przestrzenią nazw dla przestrzeni nazw usługi Service Bus.
   • Zastąp TOPIC_NAME ciąg nazwą tematu.

   W poprzednim kodzie użyto klasy biblioteki DefaultAzureCredential klienta usługi Azure Identity. Gdy aplikacja działa lokalnie podczas programowania, DefaultAzureCredential automatycznie odnajdzie i uwierzytelnia się na platformie Azure przy użyciu konta zalogowanego do interfejsu wiersza polecenia platformy Azure. Po wdrożeniu aplikacji na platformie Azure DefaultAzureCredential można uwierzytelnić aplikację w usłudze Microsoft Entra ID za pośrednictwem tożsamości zarządzanej bez żadnych zmian w kodzie.

3. Dodaj metodę wysyłania pojedynczego komunikatu.

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

   Nadawca jest obiektem, który działa jako klient utworzonego tematu. Utworzysz go później i wyślesz jako argument do tej funkcji.

4. Dodaj metodę do wysyłania listy komunikatów.

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

5. Dodaj metodę do wysyłania partii komunikatów.

   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 topic
           await sender.send_messages(batch_message)
       print("Sent a batch of 10 messages")
   

6. Utwórz klienta usługi Service Bus, a następnie obiekt nadawcy tematu do wysyłania komunikatów.

   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 Topic Sender object to send messages to the topic
           sender = servicebus_client.get_topic_sender(topic_name=TOPIC_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()
   
   asyncio.run(run())
   print("Done sending messages")
   print("-----------------------")
   

1. Dodaj następujące instrukcje import.

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

2. Dodaj następujące stałe.

   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STRING"
   TOPIC_NAME = "TOPIC_NAME"
   

   Ważne

   • Zastąp NAMESPACE_CONNECTION_STRING ciąg parametry połączenia przestrzeni nazw.
   • Zastąp TOPIC_NAME ciąg nazwą tematu.

3. Dodaj metodę wysyłania pojedynczego komunikatu.

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

   Nadawca jest obiektem, który działa jako klient utworzonego tematu. Utworzysz go później i wyślesz jako argument do tej funkcji.

4. Dodaj metodę do wysyłania listy komunikatów.

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

5. Dodaj metodę do wysyłania partii komunikatów.

   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 topic
           await sender.send_messages(batch_message)
       print("Sent a batch of 10 messages")
   

6. Utwórz klienta usługi Service Bus, a następnie obiekt nadawcy tematu do wysyłania komunikatów.

   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 Topic Sender object to send messages to the topic
           sender = servicebus_client.get_topic_sender(topic_name=TOPIC_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)
   
   asyncio.run(run())
   print("Done sending messages")
   print("-----------------------")
   

1. Podobnie jak w przykładzie wysyłania, dodaj import instrukcje, zdefiniuj stałe, które należy zastąpić własnymi wartościami i zdefiniuj poświadczenia.

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

2. Utwórz klienta usługi Service Bus, a następnie obiekt odbiorcy subskrypcji w celu odbierania komunikatów.

   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:
   
           async with servicebus_client:
               # get the Subscription Receiver object for the subscription
               receiver = servicebus_client.get_subscription_receiver(topic_name=TOPIC_NAME, 
               subscription_name=SUBSCRIPTION_NAME, max_wait_time=5)
               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 subscription
                       await receiver.complete_message(msg)
           # Close credential when no longer needed.
           await credential.close()
   

3. Wywołaj metodę run .

   asyncio.run(run())
   

1. Podobnie jak w przykładzie send, dodaj import instrukcje i zdefiniuj stałe, które należy zastąpić własnymi wartościami.

   import asyncio
   from azure.servicebus.aio import ServiceBusClient
   
   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STRING"
   SUBSCRIPTION_NAME = "SUBSCRIPTION_NAME"
   TOPIC_NAME = "TOPIC_NAME"
   

2. Utwórz klienta usługi Service Bus, a następnie obiekt odbiorcy subskrypcji w celu odbierania komunikatów.

   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 Subscription Receiver object for the subscription
               receiver = servicebus_client.get_subscription_receiver(topic_name=TOPIC_NAME, 
               subscription_name=SUBSCRIPTION_NAME, max_wait_time=5)
               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 subscription
                       await receiver.complete_message(msg)
   

3. Wywołaj metodę run .

   asyncio.run(run())