Erstellen einer Node.js-App mit dem Azure SDK für JavaScript

Dieses Dokument enthält Beispiele für den Zugriff auf Schlüsselwerte in Azure App Configuration unter Verwendung des Azure SDKs für JavaScript.

Tipp

App Configuration bietet eine JavaScript-Anbieterbibliothek, die auf dem JavaScript SDK basiert und mit umfangreicheren Features einfacher zu verwenden ist. Konfigurationseinstellungen können damit wie ein Map-Objekt verwendet werden. Außerdem stehen weitere Features wie die Konfigurationserstellung aus mehreren Bezeichnungen, die Kürzung von Schlüsselnamen sowie die automatische Auflösung von Key Vault-Verweisen zur Verfügung. Weitere Informationen finden Sie im JavaScript-Schnellstart.

Voraussetzungen

• Ein Azure-Konto mit einem aktiven Abonnement – Kostenloses Konto erstellen
• Ein App Configuration-Speicher. Hier finden Sie Informationen zum Erstellen eines Speichers.
• LTS-Versionen von Node.js. Informationen zum Installieren von Node.js direkt unter Windows oder mithilfe des Windows-Subsystems für Linux (WSL) finden Sie unter Was ist NodeJS?.

Erstellen eines Schlüssel-Wert-Paars

Fügen Sie dem App Configuration-Speicher die folgenden Schlüssel-Wert-Paare hinzu, und übernehmen Sie für Bezeichnung und Inhaltstyp die Standardwerte. Weitere Informationen zum Hinzufügen von Schlüssel-Wert-Paaren zu einem Speicher mithilfe des Azure-Portals oder der CLI finden Sie unter Erstellen eines Schlüssel-Wert-Paars.

Schlüssel	Wert
TestApp:Settings:Message	Daten aus Azure App Configuration

Einrichten der Node.js-App

1. In diesem Tutorial erstellen Sie ein neues Verzeichnis für das Projekt mit dem Namen app-configuration-example.

   mkdir app-configuration-example
   

2. Wechseln Sie zu dem neu erstellten Verzeichnis app-configuration-example.

   cd app-configuration-example
   

3. Installieren Sie die Azure App Configuration-Clientbibliothek mit dem Befehl npm install.

   npm install @azure/app-configuration
   

4. Erstellen Sie im Verzeichnis app-configuration-example eine neue Datei mit dem Namen app-configuration-example.js, und fügen Sie den folgenden Code hinzu:

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

Hinweis

Die Codeschnipsel in diesem Beispiel helfen Ihnen bei den ersten Schritten mit der App Configuration-Clientbibliothek für JavaScript. Für Ihre Anwendung sollten Sie auch berücksichtigen, dass Ausnahmen je nach Ihren Anforderungen verarbeitet werden. Weitere Informationen zur Behandlung von Ausnahmen finden Sie in unserer Dokumentation zum JavaScript SDK.

Konfigurieren der App Configuration-Verbindungszeichenfolge

1. Legen Sie eine Umgebungsvariable mit dem Namen AZURE_APPCONFIG_CONNECTION_STRING auf die Verbindungszeichenfolge für Ihren App Configuration-Speicher fest. Führen Sie an der Befehlszeile den folgenden Befehl aus:

   Windows-Eingabeaufforderung

   Um die App mithilfe der Windows-Eingabeaufforderung lokal auszuführen, führen Sie den folgenden Befehl aus, und ersetzen Sie dabei <app-configuration-store-connection-string> durch die Verbindungszeichenfolge Ihres App-Konfigurationsspeichers:

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

   PowerShell

   Wenn Sie Windows PowerShell verwenden, führen Sie den folgenden Befehl aus, und ersetzen Sie dabei <app-configuration-store-connection-string> durch die Verbindungszeichenfolge Ihres App-Konfigurationsspeichers:

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

   macOS

   Wenn Sie macOS verwenden, führen Sie den folgenden Befehl aus, und ersetzen Sie dabei <app-configuration-store-connection-string> durch die Verbindungszeichenfolge Ihres App-Konfigurationsspeichers:

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

   Linux

   Wenn Sie Linux verwenden, führen Sie den folgenden Befehl aus, und ersetzen Sie dabei <app-configuration-store-connection-string> durch die Verbindungszeichenfolge Ihres App-Konfigurationsspeichers:

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

2. Geben Sie mit dem unten stehenden Befehl den Wert der Umgebungsvariablen aus, um zu überprüfen, ob sie richtig festgelegt wurde.

   Windows-Eingabeaufforderung

   Starten Sie die Eingabeaufforderung über eine Windows-Eingabeaufforderung neu, damit die Änderung wirksam wird, und führen Sie den folgenden Befehl aus:

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Führen Sie bei Verwendung von Windows PowerShell den folgenden Befehl aus:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   Führen Sie bei Verwendung von macOS den folgenden Befehl aus:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Führen Sie bei Verwendung von Linux den folgenden Befehl aus:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Codebeispiele

Anhand der Beispielcodeschnipsel in diesem Abschnitt wird veranschaulicht, wie Sie häufige Vorgänge mit der App Configuration-Clientbibliothek für JavaScript durchführen. Fügen Sie diese Codeschnipsel dem Textkörper der Funktion run in der Datei app-configuration-example.js hinzu, die Sie weiter oben erstellt haben.

Hinweis

In der App Configuration-Clientbibliothek wird auf ein Schlüssel-Wert-Objekt als ConfigurationSetting verwiesen. Daher werden die Schlüsselwerte im App Configuration-Speicher als Konfigurationseinstellungen bezeichnet.

Unter den folgenden Links finden Sie Anleitungen für die entsprechenden Aktionen:

• Herstellen einer Verbindung mit einem App Configuration-Speicher
• Abrufen einer Konfigurationseinstellung
• Hinzufügen einer Konfigurationseinstellung
• Abrufen einer Liste mit Konfigurationseinstellungen
• Sperren einer Konfigurationseinstellung
• Entsperren einer Konfigurationseinstellung
• Aktualisieren einer Konfigurationseinstellung
• Löschen einer Konfigurationseinstellung

Herstellen einer Verbindung mit einem App Configuration-Speicher

Mit dem folgenden Codeausschnitt wird eine Instanz von AppConfigurationClient erstellt, indem die in Ihren Umgebungsvariablen gespeicherte Verbindungszeichenfolge verwendet wird.

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

Abrufen einer Konfigurationseinstellung

Mit dem folgenden Codeausschnitt wird eine Konfigurationseinstellung anhand des key-Namens abgerufen.

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

Hinzufügen einer Konfigurationseinstellung

Mit dem folgenden Codeausschnitt wird ein ConfigurationSetting-Objekt mit den Feldern key und value erstellt und die Methode addConfigurationSetting aufgerufen. Diese Methode löst eine Ausnahme aus, wenn Sie versuchen, eine Konfigurationseinstellung hinzuzufügen, die in Ihrem Speicher bereits vorhanden ist. Wenn Sie die Nutzung dieser Ausnahme vermeiden möchten, können Sie stattdessen die Methode setConfigurationSetting verwenden.

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

Abrufen einer Liste mit Konfigurationseinstellungen

Mit dem folgenden Codeausschnitt wird eine Liste mit Konfigurationseinstellungen abgerufen. Die Argumente keyFilter und labelFilter können bereitgestellt werden, um Schlüsselwerte nach key bzw. label zu filtern. Weitere Informationen zum Filtern finden Sie unter Abfragen von Konfigurationseinstellungen.

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

Sperren einer Konfigurationseinstellung

Der Sperrstatus eines Schlüsselwerts in App Configuration wird mit dem Attribut readOnly des Objekts ConfigurationSetting angegeben. Wenn readOnly auf true festgelegt ist, ist diese Einstellung gesperrt. Die Methode setReadOnly kann mit true als zweites Argument aufgerufen werden, um die Konfigurationseinstellung zu sperren.

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

Entsperren einer Konfigurationseinstellung

Wenn das Attribut readOnly für eine Konfigurationseinstellung (ConfigurationSetting) auf false festgelegt ist, ist die Einstellung entsperrt. Die Methode setReadOnly kann mit false als zweites Argument aufgerufen werden, um die Konfigurationseinstellung zu entsperren.

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

Aktualisieren einer Konfigurationseinstellung

Die Methode setConfigurationSetting kann verwendet werden, um eine vorhandene Einstellung zu aktualisieren oder eine neue zu erstellen. Mit dem folgenden Codeausschnitt wird der Wert einer vorhandenen Konfigurationseinstellung geändert.

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

Löschen einer Konfigurationseinstellung

Mit dem folgenden Codeausschnitt wird eine Konfigurationseinstellung anhand des key-Namens gelöscht.

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

App ausführen

In diesem Beispiel haben Sie eine Node.js-App erstellt, bei der die Azure App Configuration-Clientbibliothek zum Abrufen einer Konfigurationseinstellung verwendet wurde, die mit dem Azure-Portal erstellt wurde. Sie haben eine neue Einstellung hinzugefügt, eine Liste mit vorhandenen Einstellungen abgerufen und eine Einstellung gesperrt, entsperrt, aktualisiert und schließlich gelöscht.

Zu diesem Zeitpunkt sollte Ihre Datei app-configuration-example.js den folgenden Code enthalten:

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

Navigieren Sie im Konsolenfenster zu dem Verzeichnis, das die Datei app-configuration-example.js enthält, und führen Sie den folgenden Befehl aus, um die App auszuführen:

node app.js

Die folgende Ausgabe wird angezeigt:

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!

Bereinigen von Ressourcen

Wenn Sie die in diesem Artikel erstellten Ressourcen nicht mehr verwenden möchten, löschen Sie die erstellte Ressourcengruppe, um Kosten zu vermeiden.

Wichtig

Das Löschen einer Ressourcengruppe kann nicht rückgängig gemacht werden. Die Ressourcengruppe und alle darin enthaltenen Ressourcen werden unwiderruflich gelöscht. Achten Sie daher darauf, dass Sie nicht versehentlich die falsche Ressourcengruppe oder die falschen Ressourcen löschen. Falls Sie die Ressourcen für diesen Artikel in einer Ressourcengruppe erstellt haben, die andere beizubehaltende Ressourcen enthält, löschen Sie die Ressourcen einzeln über den entsprechenden Bereich, statt die Ressourcengruppe zu löschen.

1. Melden Sie sich beim Azure-Portal an, und klicken Sie auf Ressourcengruppen.
2. Geben Sie im Feld Nach Name filtern den Namen Ihrer Ressourcengruppe ein.
3. Wählen Sie in der Ergebnisliste den Ressourcengruppennamen aus, um eine Übersicht anzuzeigen.
4. Wählen Sie die Option Ressourcengruppe löschen.
5. Sie werden aufgefordert, das Löschen der Ressourcengruppe zu bestätigen. Geben Sie zur Bestätigung den Namen Ihrer Ressourcengruppe ein, und klicken Sie auf Löschen.

Daraufhin werden die Ressourcengruppe und alle darin enthaltenen Ressourcen gelöscht.

Nächste Schritte

In diesem Leitfaden wurde gezeigt, wie Sie das Azure SDK für JavaScript verwenden, um auf Schlüsselwerte in Azure App Configuration zuzugreifen.

Weitere Codebeispiele finden Sie unter:

Azure App Configuration-Clientbibliothek: Beispiele

Informationen zur Verwendung von Azure App Configuration mit JavaScript-Apps finden Sie unter:

Erstellen einer JavaScript-App mit Azure App Configuration