Partager via

Envoyer et recevoir des messages à partir de files d’attente Azure Service Bus (JavaScript)

  • Article

Dans ce tutoriel, 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 JavaScript qui utilise le package @azure/service-bus pour effectuer les actions suivantes :
    1. Envoyer un ensemble de messages à la file d’attente
    2. Recevoir ces messages de la file d’attente.

Notes

Ce guide de démarrage rapide fournit des instructions pas à pas pour un scénario simple qui consiste à envoyer des messages à une file d’attente Service Bus et à les recevoir. Vous trouverez des exemples JavaScript et TypeScript prédéfinis pour Azure Service Bus dans le dépôt du SDK Azure pour JavaScript 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.

Pour utiliser ce guide de démarrage rapide avec votre propre compte Azure, vous avez besoin des éléments suivants :

  • Installez Azure CLI, qui fournit l’authentification sans mot de passe à votre ordinateur de développement.
  • Connectez-vous avec votre compte Azure au terminal ou à l’invite de commandes avec az login.
  • Utilisez le même compte lorsque vous ajoutez le rôle de données approprié à votre ressource.
  • Exécutez le code dans le même terminal ou la même invite de commande.
  • Notez le nom de la file d’attente de votre espace de noms Service Bus. Vous en aurez besoin dans le code.

Notes

Ce didacticiel utilise des exemples que vous pouvez copier et exécuter à l’aide de Nodejs. Pour obtenir des instructions sur la création d’une application Node.js, veuillez consulter les pages Création et déploiement d’une application Node.js sur un site web Azure ou Service cloud Node.js avec Windows PowerShell.

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.

    Image illustrant la sélection de Créer une ressource, puis celles de Intégration et de Service Bus, dans le menu.

  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 Groupe de ressources, choisissez un groupe de ressources existant ou créez-en un.

    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 peut uniquement contenir 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 pas par -sb ou 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.

    6. Si vous sélectionnez le niveau Premium, indiquez si vous pouvez activer la géoréplication pour l’espace de noms. La fonctionnalité de géoréplication garantit que les métadonnées et les données d’un espace de noms sont répliquées en continu d’une région primaire vers une ou plusieurs régions secondaires.

      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.

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

      Image représentant la page Créer un espace de noms

    8. 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.

    Image représentant la page du déploiement réussi avec le lien Atteindre la ressource.

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

    Image représentant la page d’accueil de l’espace de noms Service Bus créé.

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

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

  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.

    Capture d’écran montrant la page Créer une file d’attente.

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.

Attribuer des rôles à votre utilisateur Microsoft Entra

Lors du développement localement, assurez-vous que le compte d’utilisateur qui se connecte à Azure Service Bus dispose des autorisations appropriées. Vous aurez besoin du rôle Propriétaire de données Azure Service Bus pour envoyer et recevoir des messages. Pour vous attribuer ce rôle, vous aurez besoin du rôle Administrateur de l’accès utilisateur ou d’un autre rôle qui inclut l’action Microsoft.Authorization/roleAssignments/write. Vous pouvez attribuer des rôles RBAC Azure à un utilisateur à l’aide du Portail Azure, Azure CLI ou Azure PowerShell. Découvrez les étendues disponibles pour les attributions de rôles dans la page vue d’ensemble de l’étendue.

L’exemple suivant attribue le rôle Azure Service Bus Data Owner à votre compte d’utilisateur, qui fournit un accès complet aux ressources Azure Service Bus. Dans un scénario réel, suivez le principe des privilèges minimum pour accorder aux utilisateurs uniquement les autorisations minimales nécessaires à un environnement de production plus sécurisé.

Rôles Azure intégrés pour Azure Service Bus

Pour Azure Service Bus, la gestion des espaces de noms et de toutes les ressources associées via le Portail Azure et l’API de gestion des ressources Azure est déjà protégée à l’aide du modèle Azure RBAC. Azure fournit les rôles Azure intégrés ci-dessous pour autoriser l’accès à un espace de noms Service Bus :

  • Propriétaire de données Azure Service Bus : ce rôle permet l’accès aux données de l’espace de noms Service Bus et de ses entités (files d’attente, rubriques, abonnements et filtres). Un membre de ce rôle peut envoyer et recevoir des messages à partir de files d’attente ou de rubriques et d’abonnements.
  • Expéditeur de données Azure Service Bus : utilisez ce rôle pour autoriser l’accès en envoi à l’espace de noms Service Bus et à ses entités.
  • Récepteur de données Azure Service Bus : utilisez ce rôle pour autoriser l’accès en réception à l’espace de noms Service Bus et à ses entités.

Si vous souhaitez créer un rôle personnalisé, consultez Droits requis pour les opérations Service Bus.

Ajouter un utilisateur Microsoft Entra au rôle Propriétaire Azure Service Bus

Ajoutez votre nom d’utilisateur Microsoft Entra au rôle Propriétaire de données Azure Service Bus au niveau de l’espace de noms Service Bus. Il permet à une application exécutée dans le contexte de votre compte d’utilisateur d’envoyer des messages à une file d’attente ou à une rubrique et d’en recevoir auprès d’une file d’attente ou de l’abonnement d’une rubrique.

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, cela 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.

  1. Si la page Espace de noms Service Bus n’est pas ouverte sur le Portail Azure, recherchez votre espace de noms Service Bus à l’aide de la barre de recherche principale ou du volet de navigation de gauche.

  2. Dans la page vue d’ensemble, sélectionnez Contrôle d’accès (IAM) dans le menu de gauche.

  3. Sur la page Contrôle d’accès (IAM), sélectionnez l’onglet Attributions de rôles.

  4. Sélectionnez + Ajouter dans le menu supérieur, puis Ajouter une attribution de rôle dans le menu déroulant résultant.

    Capture d’écran montrant comment attribuer un rôle.

  5. Utilisez la zone de recherche pour filtrer les résultats sur le rôle souhaité. Pour cet exemple, recherchez Azure Service Bus Data Owner et sélectionnez le résultat correspondant. Ensuite, choisissez Suivant.

  6. Sous Attribuer l’accès à, sélectionnez Utilisateur, groupe ou principal de service, puis sélectionnez + Sélectionner des membres.

  7. Dans la boîte de dialogue, recherchez votre nom d’utilisateur Microsoft Entra (généralement votre adresse e-mail utilisateur@domaine), puis choisissez Sélectionner en bas de la boîte de dialogue.

  8. Sélectionnez Vérifier + affecter pour accéder à la page finale, puis Vérifier + attribuer à nouveau pour terminer le processus.

Utilisation de Node Package Manager (NPM) pour installer le package

  1. Pour installer le ou les packages npm requis pour Service Bus, ouvrez une invite de commandes dont le chemin contient npm, remplacez le répertoire par le dossier où vous souhaitez stocker vos exemples, puis exécutez cette commande.

  2. Installez les packages suivants :

    npm install @azure/service-bus @azure/identity

Envoi de messages à une file d'attente

L’exemple de code suivant illustre comment envoyer un message à une file d’attente.

Vous devez avoir ouvert une session avec az login dans Azure CLI pour que votre ordinateur local fournisse l’authentification sans mot de passe requise dans ce code.

  1. Ouvrez votre éditeur favori, tel que Visual Studio Code.

  2. Créez un fichier appelé send.js et collez-y le code ci-dessous. Ce code envoie les noms des scientifiques à votre file d’attente sous forme de messages.

    Important

    Les informations d’identification sans mot de passe sont fournies avec DefaultAzureCredential.

    const { ServiceBusClient } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

const messages = [
    { body: "Albert Einstein" },
    { body: "Werner Heisenberg" },
    { body: "Marie Curie" },
    { body: "Steven Hawking" },
    { body: "Isaac Newton" },
    { body: "Niels Bohr" },
    { body: "Michael Faraday" },
    { body: "Galileo Galilei" },
    { body: "Johannes Kepler" },
    { body: "Nikolaus Kopernikus" }
    ];

async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createSender() can also be used to create a sender for a topic.
    const sender = sbClient.createSender(queueName);

    try {
        // Tries to send all messages in a single batch.
        // Will fail if the messages cannot fit in a batch.
        // await sender.sendMessages(messages);

        // create a batch object
        let batch = await sender.createMessageBatch();
        for (let i = 0; i < messages.length; i++) {
            // for each message in the array

            // try to add the message to the batch
            if (!batch.tryAddMessage(messages[i])) {
                // if it fails to add the message to the current batch
                // send the current batch as it is full
                await sender.sendMessages(batch);

                // then, create a new batch
                batch = await sender.createMessageBatch();

                // now, add the message failed to be added to the previous batch to this batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it still can't be added to the batch, the message is probably too big to fit in a batch
                    throw new Error("Message too big to fit in a batch");
                }
            }
        }

        // Send the last created batch of messages to the queue
        await sender.sendMessages(batch);

        console.log(`Sent a batch of messages to the queue: ${queueName}`);

        // Close the sender
        await sender.close();
    } finally {
        await sbClient.close();
    }
}

// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
    });

  3. Remplacez <SERVICE-BUS-NAMESPACE> par le nom de votre espace de noms Service Bus.

  4. et remplacez <QUEUE NAME> par le nom de la file d’attente.

  5. Ensuite, exécutez la commande à partir d’une invite de commandes pour exécuter ce fichier.

    node send.js

  6. Vous devez voir la sortie suivante.

    Sent a batch of messages to the queue: myqueue

Réception des messages d'une file d'attente

Vous devez avoir ouvert une session avec az login dans Azure CLI pour que votre ordinateur local fournisse l’authentification sans mot de passe requise dans ce code.

  1. Ouvrez votre éditeur favori, tel que Visual Studio Code

  2. Créez un fichier appelé receive.js et collez-y le code suivant.

    const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");
const { DefaultAzureCredential } = require("@azure/identity");

// Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";

// Passwordless credential
const credential = new DefaultAzureCredential();

// name of the queue
const queueName = "<QUEUE NAME>"

 async function main() {
    // create a Service Bus client using the passwordless authentication to the Service Bus namespace
    const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);

    // createReceiver() can also be used to create a receiver for a subscription.
    const receiver = sbClient.createReceiver(queueName);

    // function to handle messages
    const myMessageHandler = async (messageReceived) => {
        console.log(`Received message: ${messageReceived.body}`);
    };

    // function to handle any errors
    const myErrorHandler = async (error) => {
        console.log(error);
    };

    // subscribe and specify the message and error handlers
    receiver.subscribe({
        processMessage: myMessageHandler,
        processError: myErrorHandler
    });

    // Waiting long enough before closing the sender to send messages
    await delay(20000);

    await receiver.close();
    await sbClient.close();
}
// call the main function
main().catch((err) => {
    console.log("Error occurred: ", err);
    process.exit(1);
 });

  3. Remplacez <SERVICE-BUS-NAMESPACE> par le nom de votre espace de noms Service Bus.

  4. et remplacez <QUEUE NAME> par le nom de la file d’attente.

  5. Ensuite, exécutez la commande à partir d’une invite de commandes pour exécuter ce fichier.

    node receive.js

Vous devez voir la sortie suivante.

Received message: Albert Einstein
Received message: Werner Heisenberg
Received message: Marie Curie
Received message: Steven Hawking
Received message: Isaac Newton
Received message: Niels Bohr
Received message: Michael Faraday
Received message: Galileo Galilei
Received message: Johannes Kepler
Received message: Nikolaus Kopernikus

Dans la page Vue d’ensemble de l’espace de noms Service Bus dans le portail Azure, vous pouvez voir le nombre de messages entrants et sortants. Vous devrez peut-être attendre environ une minute puis actualiser la page pour voir les valeurs les plus récentes.

Nombre de messages entrants et sortants

Sélectionnez la file d’attente dans cette page Vue d’ensemble pour accéder à la page File d’attente Service Bus. Le nombre de messages entrants et sortants est visible dans cette page, ainsi que d’autres informations telles que la taille actuelle de la file d’attente, la taille maximale et le nombre de messages actifs.

Détails de la file d’attente

Dépannage

Si vous recevez l’une des erreurs suivantes alors que vous exécutez la version sans mot de passe du code JavaScript, vérifiez que vous avez ouvert une session avec la commande az login d’Azure CLI et que le rôle approprié est appliqué à votre compte d’utilisateur Azure :

  • Une ou plusieurs revendications « Send » sont requises pour effectuer cette opération.
  • Une ou plusieurs revendications « Receive » sont requises pour effectuer cette opération.

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.

Étapes suivantes

Voir la documentation et les exemples suivants :