Lire en anglais

Partager via

Utiliser Service Bus Explorer pour exécuter des opérations de données sur Service Bus

  • Article

Azure Service Bus permet aux applications clientes expéditrices et réceptrices de dissocier leur logique métier à l’aide de la sémantique familière de point à point (File d’attente) et de publication-abonnement (Rubrique-Abonnement).

Notes

Cet article met en évidence la fonctionnalité du Service Bus Explorer Azure qui fait partie du portail Azure.

Le Service Bus Explorer open source appartenant à la communauté est une application autonome différente de celle-ci.

Les opérations exécutées sur un espace de noms Azure Service Bus sont de deux sortes.

  • Opérations de gestion : création, mise à jour, suppression d’espace de noms, de files d’attente, de rubriques et d’abonnements Service Bus.
  • Opérations de données  : échange de messages avec des files d’attente, des rubriques et des abonnements.

Important

  • Service Bus Explorer ne prend pas en charge les opérations de gestion et les sessions.
  • Nous vous déconseillons d’utiliser Service Bus Explorer pour les messages plus volumineux, car cela peut entraîner des délais d’expiration, en fonction de la taille du message, de la latence réseau entre le client et le service Service Bus, etc. Au lieu de cela, nous vous recommandons d’utiliser votre propre client pour les messages plus volumineux, où vous pouvez spécifier vos propres valeurs de délai d’expiration.

Prérequis

Pour utiliser l’outil Service Bus Explorer, vous devez effectuer les tâches suivantes :

Utiliser Service Bus Explorer

Pour utiliser le Service Bus Explorer, accédez à l’espace de noms Service Bus sur lequel vous souhaitez effectuer des opérations.

  1. Si vous cherchez à exécuter des opérations sur une file d’attente, sélectionnez Files d’attente dans le menu de navigation. Si vous cherchez à exécuter des opérations sur une rubrique (et ses abonnements associés), sélectionnez Rubriques.

    Capture d’écran de la navigation de gauche, où l’entité peut être sélectionnée.

  2. Après avoir sélectionné Files d’attente ou Rubriques, sélectionnez la file d’attente ou la rubrique souhaitées.

    Capture d’écran de la page Files d’attente, avec une file d’attente spécifique sélectionnée.

  3. Sélectionnez Service Bus Explorer dans le menu de navigation de gauche.

    Capture d’écran de la page de file d’attente dans laquelle Service Bus Explorer peut être sélectionné.

    Notes

    Lors de l’affichage de l’aperçu ou de la réception d’un abonnement, sélectionnez d’abord l’abonnement spécifique dans le sélecteur de liste déroulante. Capture d’écran de la liste déroulante pour les abonnements aux rubriques.

    Notes

    Lorsque vous accédez à Service Bus Explorer pour une entité dans un espace de noms dont l’accès public est désactivé, vous voyez le message suivant, même si vous y accédez à partir d’une machine virtuelle qui se trouve dans le même réseau virtuel que le point de terminaison privé. Vous pouvez l’ignorer.

    « L’espace de noms dispose d’un accès réseau public désactivé. Les opérations de données telles qu’Aperçu, Envoyer ou Recevoir sur cette entité Service Bus ne fonctionnent pas tant que vous ne passez pas à tous les réseaux ou ajoutez votre adresse IP cliente à la liste d'autorisation dans les réseaux sélectionnés. »

Afficher l’aperçu d’un message

La fonctionnalité d’aperçu vous permet d’utiliser Service Bus Explorer pour afficher les 100 premiers messages d’une file d’attente, d’un abonnement ou d’une file d’attente de lettres mortes.

  1. Pour afficher un aperçu des messages, sélectionnez Mode Aperçu dans la liste déroulante Service Bus Explorer.

    Capture d’écran de la liste déroulante avec le mode Aperçu sélectionné.

  2. Consultez les mesures pour déterminer s’il existe des messages actifs ou des messages de lettres mortes à afficher, puis sélectionnez File d’attente/Abonnement ou la sous-file d’attente Lettres mortes.

    Capture d’écran des onglets de file d’attente et de sous-file d’attente de lettres mortes avec des mesures de message affichées.

  3. Sélectionnez le bouton Aperçu depuis le démarrage.

    Capture d’écran indiquant le bouton Aperçu à partir du bouton Démarrer.

  4. Une fois l’opération d’affichage de l’aperçu terminée, jusqu’à 100 messages s’affichent dans la grille comme illustré dans l’image ci-dessous. Pour afficher les détails d’un message particulier, sélectionnez-le dans la grille. Vous pouvez choisir d’afficher le corps ou les propriétés du message.

    Capture d’écran avec vue d’ensemble des messages aperçus et du contenu du corps du message affichés pour les messages aperçus.

    Basculez vers l’onglet Propriétés de message dans le volet inférieur pour afficher les métadonnées.

    Capture d’écran avec vue d’ensemble des messages aperçus et des propriétés du message affichés pour les messages aperçus.

    Notes

    Comme l’aperçu n’est pas une opération destructrice, le message n’est pas supprimé de l’entité.

    Notes

    Pour des raisons de performances, lors de l’aperçu des messages d’une file d’attente ou d’un abonnement dont la taille de message maximale est supérieure à 1 Mo, le corps du message n’est pas récupéré par défaut. Au lieu de cela, vous pouvez charger le corps du message pour un message spécifique en cliquant sur le bouton Charger le corps du message. Si le corps du message dépasse 1 Mo, il est tronqué avant d’être affiché. Capture d’écran avec vue d’ensemble des messages aperçus et du bouton pour charger le corps du message affiché.

Afficher l’aperçu d’un message avec options avancées

La fonctionnalité d’aperçu avec options vous permet d’utiliser Service Bus Explorer pour afficher les principaux messages d’une file d’attente, d’un abonnement ou de la file d’attente de lettres mortes, en spécifiant le nombre de messages à afficher et le numéro de séquence à partir duquel commencer à afficher l’aperçu.

  1. Pour afficher un aperçu des messages avec options avancées, sélectionnez Mode Aperçu dans la liste déroulante Service Bus Explorer.

    Capture d’écran de la liste déroulante avec le mode Aperçu sélectionné pour afficher un aperçu avec les options avancées.

  2. Consultez les mesures pour déterminer s’il existe des messages actifs ou des messages de lettres mortes à afficher, puis sélectionnez File d’attente/Abonnement ou la sous-file d’attente Lettres mortes.

    Capture d’écran des onglets de file d’attente et de sous-file d’attente de lettres mortes avec des mesures de message affichées pour un aperçu avec les options avancées.

  3. Sélectionnez le bouton Aperçu avec options. Indiquez le nombre de messages à afficher et le numéro de séquence à partir duquel commencer à afficher l’aperçu, puis sélectionnez le bouton Aperçu.

    Capture d’écran indiquant le bouton d’aperçu avec les options et une page dans laquelle les options peuvent être définies.

  4. Une fois l’opération d’affichage de l’aperçu terminée, les messages s’affichent dans la grille comme illustré dans l’image ci-dessous. Pour afficher les détails d’un message particulier, sélectionnez-le dans la grille. Vous pouvez choisir d’afficher le corps ou les propriétés du message.

    Capture d’écran avec vue d’ensemble des messages aperçus et du contenu du corps du message affichés pour un aperçu avec les options avancées.

    Basculez vers l’onglet Propriétés de message dans le volet inférieur pour afficher les métadonnées.

    Capture d’écran avec vue d’ensemble des messages aperçus et des propriétés du message affichés pour un aperçu avec les options avancées.

    Notes

    Comme l’aperçu n’est pas une opération destructrice, le message n’est pas supprimé de la file d’attente.

Recevoir un message

La fonction de réception de Service Bus Explorer permet de recevoir des messages à partir d’une file d’attente ou d’un abonnement.

  1. Pour recevoir des messages, sélectionnez Mode de réception dans la liste déroulante Service Bus Explorer.

    Capture d’écran de la liste déroulante avec le mode de réception sélectionné.

  2. Vérifiez les métriques pour voir s’il existe des messages actifs ou des messages de lettres mortes à recevoir, puis sélectionnez File d’attente/Abonnement ou Lettre morte.

    Capture d’écran des onglets de file d’attente et de sous-file d’attente de lettres mortes avec des mesures de messages affichées pour le mode de réception.

  3. Sélectionnez le bouton Recevoir des messages, puis spécifiez le mode de réception, le nombre de messages à recevoir, ainsi que la durée maximale d’attente d’un message, puis sélectionnez Recevoir.

    Capture d’écran montrant le bouton Recevoir et une page dans laquelle les options peuvent être définies.

    Important

    Notez que le mode ReceiveAndDelete est une réception destructrice, c’est-à-dire que le message est supprimé de la file d’attente quand il est affiché dans l’outil Service Bus Explorer.

    Pour parcourir les messages sans les supprimer de la file d’attente, vous pouvez utiliser la fonctionnalité Aperçu ou le mode de réception PeekLock.

  4. Une fois l’opération de réception terminée, les messages s’affichent dans la grille comme illustré dans l’image ci-dessous. Pour afficher les détails d’un message particulier, sélectionnez-le dans la grille.

    Capture d’écran avec vue d’ensemble des messages reçus et du contenu du corps du message affiché.

    Capture d’écran avec vue d’ensemble des messages reçus et des propriétés du message affiché.

    Notes

    Pour des raisons de performances, lors de la réception de messages d’une file d’attente ou d’un abonnement dont la taille de message maximale est supérieure à 1 Mo,un seul message est reçu à la fois. Si le corps du message dépasse 1 Mo, il est tronqué avant d’être affiché.

Après réception d’un message en mode PeekLock, plusieurs actions s’offrent à vous.

Notes

Ces actions sont impossibles tant que le message est accompagné d’un verrou.

Terminer un message

  1. Dans la grille, sélectionnez le ou les messages reçus que vous souhaitez terminer.

  2. Sélectionnez le bouton Terminer.

    Capture d’écran indiquant le bouton Terminer.

    Important

    Veuillez noter que l’exécution d’un message est une réception destructrice, c’est-à-dire que le message est supprimé de la file d’attente une fois Terminer sélectionné dans l’outil Service Bus Explorer.

Différer un message

  1. Dans la grille, sélectionnez un ou plusieurs messages reçus que vous souhaitez différer.

  2. Sélectionnez le bouton Différer.

    Capture d’écran indiquant le bouton Différer.

Abandonner le verrou

  1. Dans la grille, sélectionnez un ou plusieurs messages reçus pour lesquels vous souhaitez abandonner le verrou.

  2. Sélectionnez le bouton Abandonner le verrou.

    Capture d’écran indiquant le bouton Abandonner le verrou.

Une fois le verrou abandonné, le message est à nouveau disponible pour les opérations de réception.

Lettre morte

  1. Dans la grille, sélectionnez un ou plusieurs messages reçus que vous souhaitez mettre en lettre morte.

  2. Sélectionnez le bouton Lettre morte .

    Capture d’écran indiquant le bouton Lettre morte.

Une fois qu’un message a été mis en file d’attente de lettres mortes, il est disponible à partir de la sous-file d’attente Lettre morte.

Purger les messages

Pour vider les messages, sélectionnez le bouton Vider les messages de l’Explorateur Service Bus.

Capture d'écran indiquant le bouton de purge des messages.

Une fois que vous avez entré « purge » pour confirmer l’opération, les messages sont vidés de l’entité Service Bus correspondante.

Envoyer un message à une file d’attente ou à une rubrique

Pour envoyer un message à une File d’attente ou à une Rubrique, sélectionnez l’onglet Envoyer des messages du Service Bus Explorer.

  1. Choisissez le Type de contenuTexte/brut, Application/XML ou Application/JSON.

  2. Pour Corps du message, ajoutez le contenu du message. Assurez-vous qu’il correspond au Type de contenu défini précédemment.

  3. Définissez les Propriétés Broker (facultatif). Ces propriétés incluent l’ID de corrélation, l’ID de message, ReplyTo, l’étiquette/l’objet, la durée de vie (TTL) et l’heure de mise en file d’attente planifiée (pour les messages planifiés).

  4. Définissez les Propriétés personnalisées (facultatif). Ces propriétés peuvent être n’importe quelle propriété utilisateur définie sur une clé de dictionnaire.

  5. Cochez Répéter l’envoi pour envoyer le même message plusieurs fois. Si aucun ID de message n’a été défini, il est automatiquement renseigné avec des valeurs séquentielles.

  6. Une fois le message composé, sélectionnez le bouton Envoyer.

    Capture d’écran montrant l’expérience de composition du message.

  7. Une fois l’opération d’envoi terminée, l’une des modifications suivantes se produit :

    • En cas d’envoi à une file d’attente, le compteur de métriques Messages actifs est incrémenté.
    • En cas d’envoi à une rubrique, le compteur de métriques Messages actifs est incrémenté sur les abonnements vers lesquels le message a été acheminé.

Renvoyer un message

Après avoir afficher un aperçu ou reçu un message, vous pouvez le renvoyer, ce qui envoie une copie du message à la même entité, tout en permettant de mettre à jour son contenu et ses propriétés. Le message d’origine est conservé et n’est pas supprimé même si le renvoi s’effectue à partir de la file d’attente de lettres mortes.

  1. Dans la grille, sélectionnez un ou plusieurs messages à renvoyer.

  2. Sélectionnez le bouton Renvoyer les messages sélectionnés.

    Capture d’écran montrant le bouton Renvoyer les messages sélectionnés.

  3. Vous pouvez également sélectionner un message pour lequel vous souhaitez mettre à jour les détails et apporter les modifications souhaitées.

  4. Sélectionnez le bouton Envoyer pour envoyer les messages à l’entité.

    Capture d’écran montrant l’expérience de renvoi des messages.

    Notes

    • L’opération de renvoi envoie une copie du message d’origine. Elle ne supprime pas le message d’origine que vous renvoyez.
    • Si vous renvoyez un message dans une file d’attente de lettres mortes d’un abonnement, une copie du message est envoyée à la rubrique. Par conséquent, tous les abonnements reçoivent une copie du message.

Changer de type d’authentification

Lorsque vous utilisez Service Bus Explorer, il est possible d’utiliser la clé d’accès ou l’authentification Microsoft Entra ID.

  1. Sélectionnez le bouton Paramètres.

    Capture d’écran indiquant le bouton Paramètres dans Service Bus Explorer.

  2. Choisissez la méthode d’authentification souhaitée, puis sélectionnez le bouton Enregistrer.

    Capture d’écran montrant le bouton Paramètres et une page affichant les différents types d’authentification.

Étapes suivantes