Een Node.js-app maken met de Azure SDK voor JavaScript

In dit document ziet u voorbeelden van het gebruik van de Azure SDK voor JavaScript voor toegang tot sleutelwaarden in Azure-app Configuration.

Tip

App Configuration biedt een JavaScript-providerbibliotheek die is gebouwd op de JavaScript SDK en is ontworpen om gemakkelijker te gebruiken met uitgebreidere functies. Hiermee kunnen configuratie-instellingen worden gebruikt zoals een kaartobject en andere functies, zoals configuratiesamenstelling van meerdere labels, sleutelnaam bijsnijden en automatische resolutie van Key Vault-verwijzingen. Ga naar de JavaScript-quickstart voor meer informatie.

Vereisten

• Een Azure-account met een actief abonnement - Maak er gratis een
• Een App Configuration-archief. Een winkel maken.
• LTS-versies van Node.js. Zie Aan de slag met Node.js voor informatie over het installeren van Node.js rechtstreeks in Windows of het gebruik van de Windows-subsysteem voor Linux (WSL)

Een sleutelwaarde maken

Voeg de volgende sleutelwaarde toe aan het App Configuration-archief en laat label en inhoudstype ongewijzigd met de standaardwaarden. Ga naar Een sleutelwaarde maken voor meer informatie over het toevoegen van sleutelwaarden aan een archief met behulp van Azure Portal of de CLI.

Sleutel	Weergegeven als
TestApp:Settings:Message	Gegevens van Azure App Configuration

De Node.js-app instellen

1. In deze zelfstudie maakt u een nieuwe map voor het project met de naam app-configuration-example.

   mkdir app-configuration-example
   

2. Schakel over naar de zojuist gemaakte map met app-configuratie .

   cd app-configuration-example
   

3. Installeer de Azure App Configuration-clientbibliotheek met behulp van de opdracht npm install.

   npm install @azure/app-configuration
   

4. Maak een nieuw bestand met de naam app-configuration-example.js in de map app-configuration-example en voeg de volgende code toe:

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

Notitie

De codefragmenten in dit voorbeeld helpen u aan de slag te gaan met de App Configuration-clientbibliotheek voor JavaScript. Voor uw toepassing moet u ook rekening houden met het afhandelen van uitzonderingen op basis van uw behoeften. Raadpleeg onze JavaScript SDK-documentatie voor meer informatie over het verwerken van uitzonderingen.

Uw App Configuration-verbindingsreeks configureren

1. Stel een omgevingsvariabele in met de naam AZURE_APPCONFIG_CONNECTION_STRING en stel deze in op de verbindingsreeks van uw App Configuration-archief. Voer op de opdrachtregel de volgende opdracht uit:

   Windows-opdrachtprompt

   Als u de app lokaal wilt uitvoeren met behulp van de Windows-opdrachtprompt, voert u de volgende opdracht uit en vervangt u <app-configuration-store-connection-string> de verbindingsreeks van uw app-configuratiearchief:

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

   PowerShell

   Als u Windows PowerShell gebruikt, voert u de volgende opdracht uit en vervangt u <app-configuration-store-connection-string> de verbindingsreeks van uw app-configuratiearchief:

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

   MacOS

   Als u macOS gebruikt, voert u de volgende opdracht uit en vervangt u <app-configuration-store-connection-string> de verbindingsreeks van uw app-configuratiearchief:

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

   Linux

   Als u Linux gebruikt, voert u de volgende opdracht uit en vervangt u <app-configuration-store-connection-string> de verbindingsreeks van het app-configuratiearchief:

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

2. Druk de waarde van de omgevingsvariabele af om te controleren of deze juist is ingesteld met de onderstaande opdracht.

   Windows-opdrachtprompt

   Start met behulp van de Windows-opdrachtprompt de opdrachtprompt opnieuw om de wijziging van kracht te laten worden en voer de volgende opdracht uit:

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Als u Windows PowerShell gebruikt, voert u de volgende opdracht uit:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   MacOS

   Als u macOS gebruikt, voert u de volgende opdracht uit:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Als u Linux gebruikt, voert u de volgende opdracht uit:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Codevoorbeelden

In de voorbeeldcodefragmenten in deze sectie ziet u hoe u algemene bewerkingen uitvoert met de App Configuration-clientbibliotheek voor JavaScript. Voeg deze codefragmenten toe aan de hoofdtekst van run de functie in het bestand app-configuration-example.js dat u eerder hebt gemaakt.

Notitie

De App Configuration-clientbibliotheek verwijst naar een sleutel-waardeobject als ConfigurationSetting. Daarom worden in dit artikel de sleutel-waarden in het App Configuration-archief configuratie-instellingen genoemd.

Hieronder vindt u meer informatie over het volgende:

• Verbinding maken naar een App Configuration-archief
• Een configuratie-instelling ophalen
• Een configuratie-instelling toevoegen
• Een lijst met configuratie-instellingen ophalen
• Een configuratie-instelling vergrendelen
• Een configuratie-instelling ontgrendelen
• Een configuratie-instelling bijwerken
• Een configuratie-instelling verwijderen

Verbinding maken met een App Configuration-archief

Met het volgende codefragment wordt een exemplaar van AppConfigurationClient gemaakt met behulp van de verbindingsreeks die zijn opgeslagen in uw omgevingsvariabelen.

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

Een configuratie-instelling ophalen

Met het volgende codefragment wordt een configuratie-instelling opgehaald met de key-naam.

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

Een configuratie-instelling toevoegen

Met het volgende codefragment maakt u een ConfigurationSetting-object met de velden key en value en roept u de methode addConfigurationSetting aan. Deze methode genereert een uitzondering als u probeert een configuratie-instelling toe te voegen die al in uw archief voorkomt. Als u deze uitzondering wilt voorkomen, kan de methode setConfigurationSetting in plaats daarvan worden gebruikt.

    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}`);

Een lijst met configuratie-instellingen ophalen

Met het volgende codefragment wordt een lijst met configuratie-instellingen opgehaald. De argumenten keyFilter en labelFilter kunnen worden opgegeven om sleutel-waarden te filteren op basis van key respectievelijk label. Zie configuratie-instellingen opvragen voor meer informatie over filteren.

    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}`);
    }

Een configuratie-instelling vergrendelen

De vergrendelingsstatus van een sleutel-waarde in App Configuration wordt aangeduid met het kenmerk readOnly van het object ConfigurationSetting. Als readOnlytrueis, is de instelling vergrendeld. De setReadOnly methode kan worden aangeroepen als true het tweede argument om de configuratie-instelling te vergrendelen.

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

Een configuratie-instelling ontgrendelen

Als het readOnly-kenmerk van een ConfigurationSetting de waarde false heeft, is de instelling ontgrendeld. De setReadOnly methode kan worden aangeroepen als false het tweede argument om de configuratie-instelling te ontgrendelen.

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

Een configuratie-instelling bijwerken

De methode setConfigurationSetting kan worden gebruikt om een bestaande instelling bij te werken of een nieuwe instelling te maken. Met het volgende codefragment wordt de waarde van een bestaande configuratie-instelling gewijzigd.

    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}`);

Een configuratie-instelling verwijderen

Met het volgende codefragment wordt een configuratie-instelling met de key-naam.

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

De app uitvoeren

In dit voorbeeld hebt u een Node.js-app gemaakt die gebruikmaakt van de Azure-app Configuratieclientbibliotheek om een configuratie-instelling op te halen die is gemaakt via Azure Portal, een nieuwe instelling toe te voegen, een lijst met bestaande instellingen op te halen, een instelling te vergrendelen en ontgrendelen, een instelling bij te werken en ten slotte een instelling te verwijderen.

Op dit moment moet het bestand app-configuration-example.js de volgende code hebben:

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

Navigeer in het consolevenster naar de map met het bestand app-configuration-example.js en voer de volgende opdracht uit om de app uit te voeren:

node app.js

U moet de volgende uitvoer zien:

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!

Resources opschonen

Als u de resources die in dit artikel zijn gemaakt niet wilt blijven gebruiken, verwijdert u de resourcegroep die u hier hebt gemaakt om kosten te voorkomen.

Belangrijk

Het verwijderen van een resourcegroep kan niet ongedaan worden gemaakt. De resourcegroep en alle resources daarin worden permanent verwijderd. Zorg ervoor dat u niet per ongeluk de verkeerde resourcegroep of resources verwijdert. Als u de resources voor dit artikel in een resourcegroep hebt gemaakt die andere resources bevat die u wilt behouden, moet u elke resource afzonderlijk verwijderen uit het deelvenster in plaats van dat u de resourcegroep verwijdert.

1. Meld u aan bij de Azure-portal en selecteer Resourcegroepen.
2. Voer de naam van de resourcegroep in het vak Filteren op naam in.
3. Selecteer in de resultatenlijst de resourcegroepnaam om een overzicht te bekijken.
4. Selecteer Resourcegroep verwijderen.
5. U wordt gevraagd om het verwijderen van de resourcegroep te bevestigen. Voer de naam van de resourcegroep in ter bevestiging en selecteer Verwijderen.

Na enkele ogenblikken worden de resourcegroep en alle bijbehorende resources verwijderd.

Volgende stappen

In deze handleiding hebt u gezien hoe u de Azure SDK voor JavaScript gebruikt voor toegang tot sleutelwaarden in Azure-app-configuratie.

Ga voor meer codevoorbeelden naar:

Azure App Configuration client library samples

Voor meer informatie over het gebruik van Azure-app-configuratie met JavaScript-apps, gaat u naar:

Een JavaScript-app maken met Azure-app-configuratie