Créer une application Node.js avec le kit de développement logiciel (SDK) Azure pour JavaScript

Ce document montre des exemples d’utilisation du kit de développement logiciel (SDK) Azure pour JavaScript pour accéder aux valeurs clés dans Azure App Configuration.

Conseil

App Configuration propose une bibliothèque de fournisseur JavaScript qui s’appuie sur le kit SDK JavaScript. Elle est conçue pour être plus facile à prendre en main et plus riche en fonctionnalités. Elle permet d’utiliser les paramètres de configuration comme un objet Map et offre des fonctionnalités telles que la composition de configuration à partir de plusieurs étiquettes, le découpage des noms de clé et la résolution automatique des références Key Vault. Accédez au démarrage rapide JavaScript pour en savoir plus.

Prérequis

• Un compte Azure avec un abonnement actif : créer gratuitement un compte
• Un magasin App Configuration. Créez un magasin.
• Versions LTS de Node.js. Pour plus d’informations sur l’installation de Node.js soit directement sur Windows, soit à l’aide du Sous-système Windows pour Linux (WSL), consultez Prise en main de Node.js

Création d’une clé-valeur

Ajoutez la clé-valeur suivante au magasin App Configuration et laissez les valeurs par défaut pour Étiquette et Type de contenu. Pour plus d’informations sur l’ajout de clés-valeurs à un magasin avec le Portail Azure ou la CLI, consultez Créer une clé-valeur.

Clé	Valeur
TestApp:Settings:Message	Data from Azure App Configuration

Configurer l’application Node.js

1. Dans ce tutoriel, vous allez créer un répertoire pour le projet nommé app-configuration-example.

   mkdir app-configuration-example
   

2. Basculez vers le répertoire app-configuration-example que vous venez de créer.

   cd app-configuration-example
   

3. Installez la bibliothèque de client Azure App Configuration à l’aide de la commande npm install.

   npm install @azure/app-configuration
   

4. Créez un fichier appelé app-configuration-example.js dans le répertoire app-configuration-example, puis ajoutez le code suivant :

   const { AppConfigurationClient } = require("@azure/app-configuration");
   
   async function run() {
     console.log("Azure App Configuration - JavaScript example");
     // Example code goes here
   }
   
   run().catch(console.error);
   

Remarque

Les extraits de code de cet exemple vous aideront à utiliser la bibliothèque de client App Configuration pour JavaScript. Pour votre application, vous devez également envisager de gérer les exceptions en fonction de vos besoins. Pour en savoir plus sur la gestion des exceptions, consultez notre documentation sur le SDK JavaScript.

Configurer votre chaîne de connexion App Configuration

1. Définissez une variable d’environnement nommée AZURE_APPCONFIG_CONNECTION_STRING et affectez-lui la valeur de la chaîne de connexion à votre magasin App Configuration. Sur la ligne de commande, exécutez la commande suivante :

   Invite de commandes Windows

   Pour exécuter l’application localement en tirant parti de l’invite de commandes Windows, exécutez la commande suivante et remplacez<app-configuration-store-connection-string> par la chaîne de connexion de votre magasin de configurations des applications :

   setx AZURE_APPCONFIG_CONNECTION_STRING "<app-configuration-store-connection-string>"
   

   PowerShell

   Si vous utilisez Windows PowerShell, exécutez la commande suivante et remplacez <app-configuration-store-connection-string> par la chaîne de connexion de votre magasin de configurations des applications :

   $Env:AZURE_APPCONFIG_CONNECTION_STRING = "<app-configuration-store-connection-string>"
   

   macOS

   Si vous utilisez macOS, exécutez la commande suivante et remplacez <app-configuration-store-connection-string> par la chaîne de connexion de votre magasin de configurations des applications :

   export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
   

   Linux

   Si vous utilisez Linux, exécutez la commande suivante et remplacez <app-configuration-store-connection-string> par la chaîne de connexion de votre magasin de configurations des applications :

   export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
   

2. Imprimez la valeur de la variable d’environnement pour confirmer qu’elle est correctement définie à l’aide de la commande ci-dessous.

   Invite de commandes Windows

   Si vous utilisez l’invite de commandes Windows, redémarrez l’invite pour que la modification soit prise en compte et exécutez la commande suivante :

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Si vous utilisez Windows PowerShell, exécutez la commande suivante :

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   Si vous utilisez macOS, exécutez la commande suivante :

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Si vous utilisez Linux, exécutez la commande suivante :

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Exemples de code

Les exemples d’extraits de code de cette section vous montrent comment effectuer des opérations courantes avec la bibliothèque de client App Configuration pour JavaScript. Ajoutez ces extraits de code au corps de la fonction run dans le fichier app-configuration-example.js que vous avez créé précédemment.

Remarque

La bibliothèque de client App Configuration fait référence à un objet clé/valeur sous la forme ConfigurationSetting. Ainsi, dans cet article, les paires clé/valeur dans le magasin App Configuration sont appelées paramètres de configuration.

Découvrez ci-dessous comment :

• Se connecter à un magasin App Configuration
• Obtenir un paramètre de configuration
• Ajouter un paramètre de configuration
• Obtenir la liste des paramètres de configuration
• Verrouiller un paramètre de configuration
• Déverrouiller un paramètre de configuration
• Mettre à jour un paramètre de configuration
• Supprimer un paramètre de configuration

Se connecter à un magasin App Configuration

L’extrait de code suivant crée une instance d’AppConfigurationClient à l’aide de la chaîne de connexion stockée dans vos variables d’environnement.

const connection_string = process.env.AZURE_APPCONFIG_CONNECTION_STRING;
const client = new AppConfigurationClient(connection_string);

Obtenir un paramètre de configuration

L’extrait de code suivant récupère un paramètre de configuration par nom de clé (key).

    const retrievedConfigSetting = await client.getConfigurationSetting({
        key: "TestApp:Settings:Message"
    });
    console.log("\nRetrieved configuration setting:");
    console.log(`Key: ${retrievedConfigSetting.key}, Value: ${retrievedConfigSetting.value}`);

Ajouter un paramètre de configuration

L’extrait de code suivant crée un objet ConfigurationSetting avec les champs key et value et appelle la méthode addConfigurationSetting. Cette méthode lève une exception si vous essayez d’ajouter un paramètre de configuration qui existe déjà dans votre magasin. Pour éviter cette exception, vous pouvez utiliser la méthode setConfigurationSetting à la place.

    const configSetting = {
        key:"TestApp:Settings:NewSetting",
        value:"New setting value"
    };
    const addedConfigSetting = await client.addConfigurationSetting(configSetting);
    console.log("\nAdded configuration setting:");
    console.log(`Key: ${addedConfigSetting.key}, Value: ${addedConfigSetting.value}`);

Obtenir la liste des paramètres de configuration

L’extrait de code suivant récupère la liste des paramètres de configuration. Vous pouvez fournir les arguments keyFilter et labelFilter pour filtrer les paires clé/valeur en fonction de key et label respectivement. Pour plus d’informations sur le filtrage, découvrez comment interroger les paramètres de configuration.

    const filteredSettingsList = client.listConfigurationSettings({
        keyFilter: "TestApp*"
    });
    console.log("\nRetrieved list of configuration settings:");
    for await (const filteredSetting of filteredSettingsList) {
        console.log(`Key: ${filteredSetting.key}, Value: ${filteredSetting.value}`);
    }

Verrouiller un paramètre de configuration

L’état de verrouillage d’une paire clé/valeur dans App Configuration est indiqué par l’attribut readOnly de l’objet ConfigurationSetting. Si readOnly a pour valeur true, le paramètre est verrouillé. La méthode setReadOnly peut être appelée avec true comme deuxième argument pour verrouiller le paramètre de configuration.

    const lockedConfigSetting = await client.setReadOnly(addedConfigSetting, true /** readOnly */);
    console.log(`\nRead-only status for ${lockedConfigSetting.key}: ${lockedConfigSetting.isReadOnly}`);

Déverrouiller un paramètre de configuration

Si l’attribut readOnly d’un objet ConfigurationSetting a pour valeur false, le paramètre est déverrouillé. La méthode setReadOnly peut être appelée avec false comme deuxième argument pour déverrouiller le paramètre de configuration.

    const unlockedConfigSetting = await client.setReadOnly(lockedConfigSetting, false /** readOnly */);
    console.log(`\nRead-only status for ${unlockedConfigSetting.key}: ${unlockedConfigSetting.isReadOnly}`);

Mettre à jour un paramètre de configuration

La méthode setConfigurationSetting peut être utilisée pour mettre à jour un paramètre existant ou créer un paramètre. L’extrait de code suivant change la valeur d’un paramètre de configuration existant.

    addedConfigSetting.value = "Value has been updated!";
    const updatedConfigSetting = await client.setConfigurationSetting(addedConfigSetting);
    console.log("\nUpdated configuration setting:");
    console.log(`Key: ${updatedConfigSetting.key}, Value: ${updatedConfigSetting.value}`);

Supprimer un paramètre de configuration

L’extrait de code suivant supprime un paramètre de configuration par nom de clé (key).

    const deletedConfigSetting = await client.deleteConfigurationSetting({
        key: "TestApp:Settings:NewSetting"
    });
    console.log("\nDeleted configuration setting:");
    console.log(`Key: ${deletedConfigSetting.key}, Value: ${deletedConfigSetting.value}`);

Exécuter l’application

Dans cet exemple, vous avez créé une application Node.js qui utilise la bibliothèque de client Azure App Configuration pour récupérer un paramètre de configuration créé sur le portail Microsoft Azure, ajouter un nouveau paramètre, récupérer la liste des paramètres existants, et enfin verrouiller et déverrouiller, mettre à jour et supprimer des paramètres.

À ce stade, votre fichier app-configuration-example.js doit contenir le code suivant :

const { AppConfigurationClient } = require("@azure/app-configuration");

async function run() {
    console.log("Azure App Configuration - JavaScript example");

    const connection_string = process.env.AZURE_APPCONFIG_CONNECTION_STRING;
    const client = new AppConfigurationClient(connection_string);

    const retrievedConfigSetting = await client.getConfigurationSetting({
        key: "TestApp:Settings:Message"
    });
    console.log("\nRetrieved configuration setting:");
    console.log(`Key: ${retrievedConfigSetting.key}, Value: ${retrievedConfigSetting.value}`);

    const configSetting = {
        key: "TestApp:Settings:NewSetting",
        value: "New setting value"
    };
    const addedConfigSetting = await client.addConfigurationSetting(configSetting);
    console.log("Added configuration setting:");
    console.log(`Key: ${addedConfigSetting.key}, Value: ${addedConfigSetting.value}`);

    const filteredSettingsList = client.listConfigurationSettings({
        keyFilter: "TestApp*"
    });
    console.log("Retrieved list of configuration settings:");
    for await (const filteredSetting of filteredSettingsList) {
        console.log(`Key: ${filteredSetting.key}, Value: ${filteredSetting.value}`);
    }

    const lockedConfigSetting = await client.setReadOnly(addedConfigSetting, true /** readOnly */);
    console.log(`Read-only status for ${lockedConfigSetting.key}: ${lockedConfigSetting.isReadOnly}`);

    const unlockedConfigSetting = await client.setReadOnly(lockedConfigSetting, false /** readOnly */);
    console.log(`Read-only status for ${unlockedConfigSetting.key}: ${unlockedConfigSetting.isReadOnly}`);

    addedConfigSetting.value = "Value has been updated!";
    const updatedConfigSetting = await client.setConfigurationSetting(addedConfigSetting);
    console.log("Updated configuration setting:");
    console.log(`Key: ${updatedConfigSetting.key}, Value: ${updatedConfigSetting.value}`);

    const deletedConfigSetting = await client.deleteConfigurationSetting({
        key: "TestApp:Settings:NewSetting"
    });
    console.log("Deleted configuration setting:");
    console.log(`Key: ${deletedConfigSetting.key}, Value: ${deletedConfigSetting.value}`);
}

run().catch(console.error);

Dans la fenêtre de votre console, accédez au répertoire contenant le fichier app-configuration-example.js et exécutez la commande suivante pour exécuter l’application :

node app.js

Vous devez normalement voir la sortie suivante.

Azure App Configuration - JavaScript example

Retrieved configuration setting:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration

Added configuration setting:
Key: TestApp:Settings:NewSetting, Value: New setting value

Retrieved list of configuration settings:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration
Key: TestApp:Settings:NewSetting, Value: New setting value

Read-only status for TestApp:Settings:NewSetting: true

Read-only status for TestApp:Settings:NewSetting: false

Updated configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Deleted configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Nettoyer les ressources

Si vous ne souhaitez plus utiliser les ressources créées dans cet article, supprimez le groupe de ressources que vous avez créé ici afin d’éviter des frais.

Important

La suppression d’un groupe de ressources est irréversible. Le groupe de ressources et toutes les ressources qu’il contient sont supprimés définitivement. Veillez à ne pas supprimer accidentellement les mauvaises ressources ou le mauvais groupe de ressources. Si vous avez créé les ressources pour cet article dans un groupe de ressources contenant d’autres ressources que vous souhaitez conserver, supprimez chaque ressource individuellement à partir de son volet, au lieu de supprimer l’intégralité du groupe de ressources.

1. Connectez-vous au portail Azure, puis sélectionnez Groupes de ressources.
2. Dans la zone Filtrer par nom, entrez le nom de votre groupe de ressources.
3. Dans la liste de résultats, sélectionnez le nom du groupe de ressources pour afficher une vue d’ensemble.
4. Sélectionnez Supprimer le groupe de ressources.
5. Vous êtes invité à confirmer la suppression du groupe de ressources. Entrez le nom de votre groupe de ressources à confirmer, puis sélectionnez Supprimer.

Après quelques instants, le groupe de ressources et toutes ses ressources sont supprimés.

Étapes suivantes

Ce guide vous a montré comment utiliser le kit SDK Azure pour JavaScript afin d’accéder aux valeurs clés dans Azure App Configuration.

Pour obtenir des exemples de code supplémentaires, visitez :

Exemples pour la bibliothèque de client Azure App Configuration

Pour savoir comment utiliser Azure App Configuration avec des applications JavaScript, cliquez sur le lien suivant :

Créer une application JavaScript avec Azure App Configuration