Démarrage rapide : Envoyer et recevoir des messages à destination et en provenance d’une file d’attente Azure Service Bus (.NET)

Dans ce guide de démarrage rapide, vous allez effectuer les étapes suivantes :

1. Créer un espace de noms Service Bus à l’aide du Portail Azure.

2. Créer une file d’attente Service Bus à l’aide du portail Azure.

3. Écrivez une application de console .NET pour envoyer un ensemble de messages à la file d’attente.

4. Écrivez une application de console .NET pour recevoir les messages de la file d’attente.

   Notes

   Ce guide de démarrage rapide fournit des instructions pas à pas pour implémenter un scénario simple qui consiste à envoyer un lot de messages à une file d’attente Service Bus, puis à les recevoir. Pour obtenir une vue d’ensemble de la bibliothèque de client .NET, consultez bibliothèque de client Azure Service Bus pour .NET. Pour plus d’échantillons, consultez Exemples relatifs à Service Bus .NET sur GitHub.

Prérequis

Si vous débutez avec le service, consultez Vue d’ensemble de Service Bus avant de suivre ce démarrage rapide.

• Abonnement Azure. Pour utiliser des services Azure, dont Azure Service Bus, vous avez besoin d’un abonnement. Si vous n’avez pas de compte Azure existant, vous pouvez demander un essai gratuit.
• Visual Studio 2022. L’exemple d’application utilise les nouvelles fonctionnalités introduites dans C# 10. Vous pouvez toujours utiliser la bibliothèque cliente Service Bus avec les versions antérieures du langage C#, mais la syntaxe peut varier. Pour utiliser la dernière syntaxe, nous vous recommandons d’installer .NET 6.0 ou une version supérieure et de définir la version du langage sur latest. Si vous utilisez Visual Studio, les versions antérieures à Visual Studio 2022 ne sont pas compatibles avec les outils nécessaires à la génération de projets C# 10.

Créer un espace de noms dans le Portail Azure

Pour commencer à utiliser des entités de messagerie Service Bus dans Azure, vous devez d’abord créer un espace de noms avec un nom unique dans Azure. Un espace de noms fournit un conteneur d’étendue pour les ressources du Service Bus (files d’attente, thèmes, etc.) au sein de votre application.

Pour créer un espace de noms :

1. Connectez-vous au portail Azure.

2. Accédez à la page Tous les services.

3. Dans la barre de navigation à gauche, sélectionnez Intégration dans la liste des catégories, passez votre curseur sur Service Bus, puis cliquez le bouton + dans la vignette Service Bus.

   

4. Dans l’étiquette De base de la page Créer un espace de noms, suivez ces étapes :

   1. Pour l’option Abonnement, choisissez un abonnement Azure dans lequel créer l’espace de noms.

   2. Pour l’option Groupe de ressources, choisissez un groupe de ressources existant dans lequel l’espace de noms sera utilisé, ou créez-en un nouveau.

   3. Entrez un nom pour l’espace de noms. Le nom de l’espace de noms doit respecter les conventions de nommage suivantes :

      • Le nom doit être unique dans tout Azure. Le système vérifie immédiatement si le nom est disponible.
      • Le nom doit inclure entre 6 et 50 caractères.
      • Le nom ne peut contenir que des lettres, des chiffres et des traits d’union (« - »).
      • Le nom doit commencer par une lettre, et se terminer par une lettre ou un chiffre.
      • Le nom ne se termine ni par « -sb » ni par « -mgmt ».

   4. Pour l’option Emplacement, choisissez la région dans laquelle héberger votre espace de noms.

   5. Pour le Niveau tarifaire, sélectionnez le SKU (De base, Standard ou Premium) destiné à l’espace de noms. Pour ce guide de démarrage rapide, sélectionnez Standard.

      Important

      Si vous voulez utiliser des rubriques et des abonnements, choisissez Standard ou Premium. Les rubriques/abonnements ne sont pas pris en charge dans le niveau tarifaire De base.

      Si vous avez sélectionné le SKU Premium, précisez le nombre d’unité de messagerie. Le niveau Premium isole les ressources au niveau du processeur et de la mémoire, ce qui permet d’exécuter chaque charge de travail de manière isolée. Ce conteneur de ressources est appelé unité de messagerie. Un espace de noms Premium a au moins une unité de messagerie. Vous pouvez sélectionner 1, 2, 4, 8 ou 16 unités de messagerie pour chaque espace de noms Service Bus Premium. Pour plus d’informations, consultez Messagerie Service Bus Premium.

   6. Au bas de la page, sélectionnez Examiner et créer.

      

   7. Dans la page Vérifier + créer, passez en revue les paramètres, puis sélectionnez Créer.

5. Une fois le déploiement de la ressource réussi, sélectionnez Accéder à la ressource dans la page de déploiement.

   

6. Vous voyez la page d’accueil de votre espace de noms Service Bus.

   

Créer une file d’attente dans le portail Azure

1. Dans la page Espace de noms Service Bus, sélectionnez Files d’attente dans le menu de navigation de gauche.

2. Dans la page Files d’attente, sélectionnez + File d’attente dans la barre d’outils.

3. Entrez un nom pour la file d’attente et laissez les valeurs par défaut des autres valeurs.

4. À présent, sélectionnez Créer.

   

Authentifier l’application sur Azure

Ce guide de démarrage pratique vous montre deux façons de vous connecter à Azure Service Bus : sans mot de passe et avec une chaîne de connexion.

La première option vous explique comment utiliser votre principal de sécurité dans Microsoft Entra ID et le contrôle d’accès en fonction du rôle (RBAC) pour vous connecter à un espace de noms Service Bus. Vous n’avez pas à vous soucier d’avoir une chaîne de connexion codée en dur dans votre code, dans un fichier config ni dans un stockage sécurisé comme Azure Key Vault.

La deuxième option consiste à se servir d’une chaîne de connexion pour se connecter à un espace de noms Service Bus. Si vous débutez avec Azure, vous trouverez peut-être l’option chaîne de connexion plus facile à suivre. Nous vous recommandons d’utiliser l’option sans mot de passe dans les applications réelles et les environnements de production. Pour plus d’informations, consultez Authentification et autorisation. Pour en savoir plus sur l’authentification sans mot de passe, reportez-vous à la page de présentation.

Lancer Visual Studio et vous connecter à Azure

Vous pouvez autoriser l’accès à l’espace de noms Service Bus en procédant comme suit :

1. Lancez Visual Studio. Si la fenêtre Démarrage s’affiche, sélectionnez le lien Continuer sans code dans le volet de droite.

2. Sélectionnez le bouton Se connecter en haut à droite de Visual Studio.

   

3. Connectez-vous à l’aide du compte Microsoft Entra auquel vous avez attribué un rôle précédemment.

   

Envoyer des messages à la file d’attente

Cette section montre comment créer une application console .NET pour envoyer des messages à une file d’attente Service Bus.

Création d’une application console

1. Dans Visual Studio, sélectionnez le menu Fichier - >Nouveau - >Projet.

2. Dans la boîte de dialogue Créer un projet, effectuez les étapes suivantes : Si vous ne voyez pas cette boîte de dialogue, sélectionnez Fichier dans le menu, sélectionnez Nouveau, puis Projet.

   1. Sélectionnez C# en guise de langage de programmation.

   2. Sélectionnez Console comme type de l’application.

   3. Sélectionnez Application console dans la liste des résultats.

   4. Ensuite, sélectionnez Suivant.

      

3. Entrez QueueSender pour le nom du projet, ServiceBusQueueQuickStart pour le nom de la solution, puis sélectionnez Suivant.

   

4. Dans la page Informations supplémentaires, sélectionnez Créer pour créer la solution et le projet.

Ajouter les paquets NuGet au projet

Ajouter du code pour envoyer des messages à la file d’attente

1. Remplacez le contenu de Program.cs par le code suivant. Les étapes importantes sont décrites dans la section suivante, avec des informations supplémentaires dans les commentaires de code.

   • Sans mot de passe
   • Chaîne de connexion

   • Crée un objet ServiceBusClient à l’aide de l’objetDefaultAzureCredential. DefaultAzureCredential détecte et utilise automatiquement les informations d’identification de votre connexion Visual Studio pour vous authentifier auprès d’Azure Service Bus.
   • Utilise la méthode CreateSender sur l’objet ServiceBusClient pour créer un objet ServiceBusSender pour la file d’attente Service Bus spécifique.
   • Crée un objet ServiceBusMessageBatch à l’aide de la méthode ServiceBusSender.CreateMessageBatchAsync.
   • Ajoutez des messages au lot à l’aide de ServiceBusMessageBatch.TryAddMessage.
   • Envoie le lot de messages à file d’attente Service Bus à l’aide de la méthode ServiceBusSender.SendMessagesAsync.

   Important

   Mettez à jour les valeurs d’espace réservé (<NAMESPACE-NAME> et <QUEUE-NAME>) dans l’extrait de code avec les noms de votre espace de noms et de votre file d’attente Service Bus.

   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // name of your Service Bus queue
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the sender used to publish messages to the queue
   ServiceBusSender sender;
   
   // number of messages to be sent to the queue
   const int numOfMessages = 3;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses the port 443. 
   // If you use the default AmqpTcp, ensure that ports 5671 and 5672 are open.
   var clientOptions = new ServiceBusClientOptions
   { 
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   //TODO: Replace the "<NAMESPACE-NAME>" and "<QUEUE-NAME>" placeholders.
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   sender = client.CreateSender("<QUEUE-NAME>");
   
   // create a batch 
   using ServiceBusMessageBatch messageBatch = await sender.CreateMessageBatchAsync();
   
   for (int i = 1; i <= numOfMessages; i++)
   {
       // try adding a message to the batch
       if (!messageBatch.TryAddMessage(new ServiceBusMessage($"Message {i}")))
       {
           // if it is too large for the batch
           throw new Exception($"The message {i} is too large to fit in the batch.");
       }
   }
   
   try
   {
       // Use the producer client to send the batch of messages to the Service Bus queue
       await sender.SendMessagesAsync(messageBatch);
       Console.WriteLine($"A batch of {numOfMessages} messages has been published to the queue.");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await sender.DisposeAsync();
       await client.DisposeAsync();
   }
   
   Console.WriteLine("Press any key to end the application");
   Console.ReadKey();
   

2. Générez le projet et vérifiez qu’il ne présente pas d’erreurs.

3. Exécutez le programme et attendez le message de confirmation.

   A batch of 3 messages has been published to the queue
   

   Important

   Dans la plupart des cas, la propagation de l’attribution de rôle dans Azure peut prendre une ou deux minutes. Dans de rares cas, il peut prendre jusqu’à huit minutes. Si vous recevez des erreurs d’authentification lorsque vous exécutez votre code pour la première fois, patientez quelques instants et réessayez.

4. Dans le portail Azure, procédez comme suit :

   1. Accédez à votre espace de noms Service Bus.

   2. Dans la page Vue d’ensemble, sélectionnez la file d’attente dans le volet central inférieur.

      

   3. Remarquez les valeurs figurant dans la section Bases.

      

   Remarquez les valeurs suivantes :

   • La valeur Nombre de messages actifs pour la file d’attente est à présent égale à 3. Chaque fois que vous exécutez cette application d’expéditeur sans récupérer les messages, cette valeur augmente de 3.
   • La taille actuelle de la file d’attente augmente chaque fois que l’application y ajoute des messages.
   • Dans le graphique Messages de la section inférieure Métriques, vous pouvez voir qu’il y a trois messages entrants pour la file d’attente.

Recevoir les messages de la file d’attente

Dans cette section, vous allez créer une application console .NET qui reçoit des messages de la file d’attente.

Créer un projet pour le récepteur

1. Dans la fenêtre Explorateur de solutions, cliquez avec le bouton droit sur la solution ServiceBusQueueQuickStart, pointez sur Ajouter, puis sélectionnez Nouveau projet.
2. Sélectionnez Application console, puis Suivant.
3. Entrez QueueReceiver pour Nom du projet, puis sélectionnez Créer.
4. Dans la fenêtre Explorateur de solutions, cliquez avec le bouton droit sur QueueReceiver, puis sélectionnez Définir comme projet de démarrage.

Ajouter les paquets NuGet au projet

Ajouter le code pour recevoir des messages de la file d’attente

Dans cette section, vous allez ajouter du code pour récupérer les messages de la file d’attente.

1. Dans la classe Program, ajoutez le code suivant :

   • Sans mot de passe
   • Chaîne de connexion

   using System.Threading.Tasks;
   using Azure.Identity;
   using Azure.Messaging.ServiceBus;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   

2. Ajoutez les méthodes suivantes à la fin de la classe Program.

   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

3. Ajoutez le code suivant à la fin de la classe Program. Les étapes importantes sont décrites dans la section suivante, avec des informations supplémentaires dans les commentaires de code.

   • Sans mot de passe
   • Chaîne de connexion

   • Crée un objet ServiceBusClient à l’aide de l’objetDefaultAzureCredential. DefaultAzureCredential découvre et utilise automatiquement les informations d’identification de votre connexion Visual Studio pour vous authentifier auprès d’Azure Service Bus.
   • Appelle la méthode CreateProcessor sur l'objet ServiceBusClient pour créer un objet ServiceBusProcessor pour la file d’attente Service Bus spécifiée.
   • Spécifie des gestionnaires pour les événements ProcessMessageAsync et ProcessErrorAsync de l’objet ServiceBusProcessor.
   • Démarre le traitement des messages en appelant StartProcessingAsync sur l' objet ServiceBusProcessor.
   • Lorsque l’utilisateur appuie sur une clé pour terminer le traitement, il appelle StopProcessingAsync sur l' objet ServiceBusProcessor.

   Important

   Mettez à jour les valeurs d’espace réservé (<NAMESPACE-NAME> et <QUEUE-NAME>) dans l’extrait de code avec les noms de votre espace de noms et de votre file d’attente Service Bus.

   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443. 
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> placeholder
   var clientOptions = new ServiceBusClientOptions()
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   

4. La classe Program terminée doit correspondre au code suivant :

   • Sans mot de passe
   • Chaîne de connexion

   using System.Threading.Tasks;
   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443.
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> and <QUEUE-NAME> placeholders
   var clientOptions = new ServiceBusClientOptions() 
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient("<NAMESPACE-NAME>.servicebus.windows.net", 
       new DefaultAzureCredential(), clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   
   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

5. Générez le projet et vérifiez qu’il ne présente pas d’erreurs.

6. Exécutez l’application réceptrice. Vous devriez voir les messages reçus. Appuyez sur n’importe quelle touche pour arrêter le récepteur et l’application.

   Wait for a minute and then press any key to end the processing
   Received: Message 1
   Received: Message 2
   Received: Message 3
   
   Stopping the receiver...
   Stopped receiving messages
   

7. Vérifiez à nouveau le portail. Attendez quelques minutes et actualisez la page si vous ne voyez pas 0 pour Nombre de messages actifs.

   • Les valeurs Nombre de messages actifs et Taille actuelle sont à présent égales à 0.

   • Dans le graphique Messages de la section Métriques en bas, vous pouvez voir trois messages entrants et trois messages sortants pour la file d’attente.

     

Nettoyer les ressources

Accédez à votre espace de noms Service Bus dans le Portail Azure, puis sélectionnez Supprimer sur le Portail Azure pour supprimer l’espace de noms et la file d’attente qu’il contient.

Voir aussi

Consultez la documentation et les exemples suivants :

• Bibliothèque de client Azure Service Bus pour .NET – Fichier Lisez-moi
• Exemples sur GitHub
• Informations de référence sur l’API .NET
• Faire abstraction des aspects de l’infrastructure avec des frameworks de niveau supérieur comme NServiceBus

Étapes suivantes