Inviare e ricevere messaggi dalle code del bus di servizio di Azure (Python)

Per usare questo avvio rapido con il proprio account Azure:

• Installare l'interfaccia della riga di comando di Azure, che fornisce l'autenticazione senza password al computer per sviluppatori.
• Accedere con l'account Azure al terminale o al prompt dei comandi con az login.
• Usare lo stesso account quando si aggiunge il ruolo dati appropriato alla risorsa.
• Eseguire il codice nello stesso terminale o nel prompt dei comandi.
• Prendere nota del nome della coda per lo spazio dei nomi del Bus di servizio. Sarà necessario nel codice.

Si noti quanto segue, che verrà usato nel codice seguente:

• Stringa di connessione dello spazio dei nomi del Bus di servizio
• Coda dello spazio dei nomi del Bus di servizio creata

Assegnare ruoli all'utente di Microsoft Entra

Quando si sviluppa in locale, assicurarsi che l'account utente che si connette al Bus di servizio di Azure disponga delle autorizzazioni corrette. Per inviare e ricevere messaggi, è necessario il ruolo Proprietario dei dati del Bus di servizio di Azure. Per assegnare a se stessi questo ruolo, è necessario il ruolo Amministratore accesso utenti o un altro ruolo che include l'azione Microsoft.Authorization/roleAssignments/write. È possibile assegnare ruoli controllo degli accessi in base al ruolo di Azure a un utente usando il portale di Azure, l'interfaccia della riga di comando di Azure o Azure PowerShell. Altre informazioni sugli ambiti disponibili per le assegnazioni di ruolo sono disponibili nella pagina panoramica dell'ambito .

L'esempio seguente assegna il ruolo Azure Service Bus Data Owner all'account utente, che fornisce l'accesso completo alle risorse del Bus di servizio di Azure. In uno scenario reale, seguire il Principio dei privilegi minimi per concedere agli utenti solo le autorizzazioni minime necessarie per un ambiente di produzione più sicuro.

Ruoli predefiniti di Azure per il Bus di servizio di Azure

Per il Bus di servizio di Azure, la gestione degli spazi dei nomi e di tutte le risorse correlate tramite il portale di Azure e l'API Gestione risorse di Azure è già protetto mediante il modello RBAC di Azure. Azure fornisce i ruoli predefiniti di Azure seguenti per autorizzare l'accesso a uno spazio dei nomi del Bus di servizio:

• Proprietario dei dati del Bus di servizio di Azure: consente l'accesso dei dati allo spazio dei nomi del Bus di servizio e alle relative entità (code, argomenti, sottoscrizioni e filtri). Un membro di questo ruolo può inviare e ricevere messaggi da code o argomenti/sottoscrizioni.
• Mittente dati del bus di servizio di Azure: usare questo ruolo per concedere all'invio l'accesso allo spazio dei nomi del bus di servizio e alle relative entità.
• Destinatario dei dati del Bus di servizio di Azure: usare questo ruolo per concedere alla ricezione l'accesso allo spazio dei nomi del Bus di servizio e alle relative entità.

Per creare un ruolo personalizzato, vedere Diritti necessari per le operazioni del Bus di servizio.

Aggiungere l'utente di Microsoft Entra al ruolo Proprietario del Bus di servizio di Azure

Aggiungere il nome utente di Microsoft Entra al ruolo Proprietario dei dati del Bus di servizio di Azure a livello di spazio dei nomi del Bus di servizio. Consentirà a un'app in esecuzione nel contesto dell'account utente di inviare messaggi a una coda o a un argomento e di ricevere messaggi da una coda o da una sottoscrizione di un argomento.

1. Se la pagina Spazio dei nomi del Bus di servizio non è aperta nel portale di Azure, individuare lo spazio dei nomi del Bus di servizio usando la barra di ricerca principale o lo spostamento a sinistra.

2. Nella pagina di panoramica selezionare Controllo di accesso (IAM) nel menu a sinistra.

3. Nella pagina Controllo di accesso (IAM), selezionare la scheda Assegnazioni di ruolo.

4. Selezionare + Aggiungi dal menu in alto e quindi Aggiungi assegnazione di ruolo dal menu a discesa risultante.

   

5. Usare la casella di ricerca per filtrare i risultati in base al ruolo desiderato. Per questo esempio, cercare Azure Service Bus Data Owner e selezionare il risultato corrispondente. Scegliere quindi Avanti.

6. In Assegna accesso a selezionare Utente, gruppo o entità servizio e quindi scegliere + Seleziona membri.

7. Nella finestra di dialogo cercare il nome utente di Microsoft Entra (in genere l'indirizzo di posta elettronica user@domain) e quindi scegliere Selezionare nella parte inferiore della finestra di dialogo.

8. Selezionare Rivedi e assegna per passare alla pagina finale e quindi Rivedi e assegna di nuovo per completare il processo.

Ottenere la stringa di connessione

Con la creazione di un nuovo spazio dei nomi viene generato automaticamente un criterio di Firma di accesso condiviso (SAS) con chiavi primaria e secondaria e stringhe di connessione primaria e secondaria, ognuna delle quali concede il controllo completo su tutti gli aspetti dello spazio dei nomi. Per informazioni su come creare regole con diritti più limitati per mittenti e ricevitori, vedere Autenticazione e autorizzazione del bus di servizio.

Un client può usare la stringa di connessione per connettersi allo spazio dei nomi di Bus di servizio. Per copiare la stringa di connessione primaria per lo spazio dei nomi, procedere come segue:

1. Nella pagina Spazio dei nomi di Bus di servizio selezionare Criteri di accesso condivisi nel menu a sinistra.

2. Nella pagina Criteri di accesso condiviso selezionare RootManageSharedAccessKey.

3. Nella finestra Criteri: RootManageSharedAccessKey selezionare il pulsante Copia accanto a Stringa di connessione primaria per copiare la stringa di connessione negli Appunti e usarla in un secondo momento. Incollare questo valore nel Blocco note o in un'altra posizione temporanea.

   

   È possibile usare questa pagina per copiare la chiave primaria, la chiave secondaria, la stringa di connessione primaria e la stringa di connessione secondaria.

1. Per installare i pacchetti Python necessari per questa esercitazione sul Bus di servizio, aprire un prompt dei comandi con Python nel percorso, andare alla cartella in cui si vogliono avere gli esempi.

2. Installare i pacchetti seguenti:

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

1. Per installare i pacchetti Python necessari per questa esercitazione sul Bus di servizio, aprire un prompt dei comandi con Python nel percorso, andare alla cartella in cui si vogliono avere gli esempi.

2. Installare il pacchetto seguente:

   pip install azure-servicebus
   

1. Aggiungere istruzioni di importazione.

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

2. Aggiungere costanti e definire credenziali.

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

   Importante

   • Sostituire FULLY_QUALIFIED_NAMESPACE con lo spazio dei nomi completo per lo spazio dei nomi del Bus di servizio.
   • Sostituire QUEUE_NAME con il nome della coda.

3. Aggiungere un metodo per inviare un singolo messaggio.

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

   Il mittente è un oggetto che funge da client per la coda creata. Verrà creato in seguito e verrà inviato come argomento a questa funzione.

4. Aggiungere un metodo per inviare un elenco di messaggi.

   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. Aggiungere un metodo per inviare un batch di messaggi.

   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. Creare un client del bus di servizio e quindi un oggetto mittente della coda per l'invio di messaggi.

   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. Chiamare il metodo run e stampare un messaggio.

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

1. Aggiungere istruzioni di importazione.

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

2. Aggiungere costanti.

   NAMESPACE_CONNECTION_STR = "NAMESPACE_CONNECTION_STR"
   QUEUE_NAME = "QUEUE_NAME"
   

   Importante

   • Sostituire NAMESPACE_CONNECTION_STR con la stringa di connessione per lo spazio dei nomi del bus di servizio.
   • Sostituire QUEUE_NAME con il nome della coda.

3. Aggiungere un metodo per inviare un singolo messaggio.

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

   Il mittente è un oggetto che funge da client per la coda creata. Verrà creato in seguito e verrà inviato come argomento a questa funzione.

4. Aggiungere un metodo per inviare un elenco di messaggi.

   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. Aggiungere un metodo per inviare un batch di messaggi.

   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. Creare un client del bus di servizio e quindi un oggetto mittente della coda per l'invio di messaggi.

   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. Chiamare il metodo run e stampare un messaggio.

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

1. Analogamente all'esempio di invio, aggiungere import istruzioni, definire costanti da sostituire con i propri valori e definire le credenziali.

   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. Creare un client del Bus di servizio quindi un oggetto ricevitore della coda per ricevere messaggi.

   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. Chiamare il metodo run .

   asyncio.run(run())
   

1. Analogamente all'esempio di invio, aggiungere import istruzioni e definire costanti da sostituire con i propri valori.

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

2. Creare un client del Bus di servizio quindi un oggetto ricevitore della coda per ricevere messaggi.

   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. Chiamare il metodo run .

   asyncio.run(run())