Vytvoření aplikace Node.js pomocí sady Azure SDK pro JavaScript

Tento dokument ukazuje příklady použití sady Azure SDK pro JavaScript pro přístup k hodnotám klíčů v Aplikace Azure Configuration.

Tip

App Configuration nabízí knihovnu zprostředkovatele JavaScriptu, která je postavená na sadě JavaScript SDK a je navržená tak, aby se snadněji používala s bohatšími funkcemi. Umožňuje použít nastavení konfigurace, jako je objekt mapy, a nabízí další funkce, jako je složení konfigurace z více popisků, oříznutí názvu klíče a automatické rozlišení odkazů služby Key Vault. Další informace najdete v rychlém startu pro JavaScript.

Požadavky

• Účet Azure s aktivním předplatným – Vytvořte si ho zdarma
• App Configuration Store. Vytvořte úložiště.
• LTS verze Node.js. Informace o instalaci Node.js přímo ve Windows nebo použití Subsystém Windows pro Linux (WSL) najdete v tématu Začínáme s Node.js.

Vytvoření hodnoty klíče

Přidejte do obchodu App Configuration následující klíč-hodnota a ponechte popisek a typ obsahu s výchozími hodnotami. Další informace o tom, jak přidat hodnoty klíčů do úložiště pomocí webu Azure Portal nebo rozhraní příkazového řádku, najdete v tématu Vytvoření hodnoty klíče.

Key	Hodnota
TestApp:Nastavení:Message	Data z konfigurace Aplikace Azure

Nastavení aplikace Node.js

1. V tomto kurzu vytvoříte nový adresář pro projekt s názvem app-configuration-example.

   mkdir app-configuration-example
   

2. Přepněte do nově vytvořeného adresáře s ukázkou konfigurace aplikace.

   cd app-configuration-example
   

3. Pomocí příkazu nainstalujte klientskou knihovnu npm install Aplikace Azure Configuration.

   npm install @azure/app-configuration
   

4. V adresáři s příkladem konfigurace aplikace vytvořte nový soubor s názvem app-configuration-example.js a přidejte následující kód:

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

Poznámka:

Fragmenty kódu v tomto příkladu vám pomůžou začít s klientskou knihovnou App Configuration pro JavaScript. U aplikace byste také měli zvážit zpracování výjimek podle vašich potřeb. Další informace o zpracování výjimek najdete v naší dokumentaci k sadě JavaScript SDK.

Konfigurace připojovací řetězec konfigurace aplikace

1. Nastavte proměnnou prostředí s názvem AZURE_APPCONFIG_CONNECTION_STRING a nastavte ji na připojovací řetězec vašeho App Configuration Storu. Na příkazovém řádku spusťte následující příkaz:

   Příkazový řádek windows

   Pokud chcete aplikaci spustit místně pomocí příkazového řádku Windows, spusťte následující příkaz a nahraďte <app-configuration-store-connection-string> připojovací řetězec úložiště konfigurace aplikací:

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

   PowerShell

   Pokud používáte Windows PowerShell, spusťte následující příkaz a nahraďte <app-configuration-store-connection-string> připojovací řetězec úložiště konfigurace aplikací:

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

   macOS

   Pokud používáte macOS, spusťte následující příkaz a nahraďte <app-configuration-store-connection-string> připojovací řetězec úložiště konfigurace aplikací:

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

   Linux

   Pokud používáte Linux, spusťte následující příkaz a nahraďte <app-configuration-store-connection-string> připojovací řetězec úložiště konfigurace vaší aplikace:

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

2. Vytiskněte hodnotu proměnné prostředí, abyste ověřili, že je správně nastavená pomocí následujícího příkazu.

   Příkazový řádek windows

   Pomocí příkazového řádku systému Windows restartujte příkazový řádek, aby se změna projevila, a spusťte následující příkaz:

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Pokud používáte Windows PowerShell, spusťte následující příkaz:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   Pokud používáte macOS, spusťte následující příkaz:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Pokud používáte Linux, spusťte následující příkaz:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Ukázky kódu

Ukázkové fragmenty kódu v této části ukazují, jak provádět běžné operace s klientskou knihovnou App Configuration pro JavaScript. Přidejte tyto fragmenty kódu do těla run funkce v souboru app-configuration-example.js , který jste vytvořili dříve.

Poznámka:

Klientská knihovna App Configuration odkazuje na objekt klíč-hodnota jako ConfigurationSetting. V tomto článku se proto hodnoty klíčů v App Configuration Storu označují jako nastavení konfigurace.

Přečtěte si následující postupy:

• Připojení do App Configuration Storu
• Získání nastavení konfigurace
• Přidání nastavení konfigurace
• Získání seznamu nastavení konfigurace
• Uzamčení nastavení konfigurace
• Odemknutí nastavení konfigurace
• Aktualizace nastavení konfigurace
• Odstranění nastavení konfigurace

Připojení do App Configuration Storu

Následující fragment kódu vytvoří instanci AppConfigurationClient pomocí připojovací řetězec uložené v proměnných prostředí.

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

Získání nastavení konfigurace

Následující fragment kódu načte nastavení konfigurace podle key názvu.

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

Přidání nastavení konfigurace

Následující fragment kódu vytvoří ConfigurationSetting objekt s key poli a value vyvolá metodu addConfigurationSetting . Tato metoda vyvolá výjimku, pokud se pokusíte přidat nastavení konfigurace, které již v úložišti existuje. Pokud se chcete této výjimce vyhnout, můžete místo toho použít metodu setConfigurationSetting .

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

Získání seznamu nastavení konfigurace

Následující fragment kódu načte seznam nastavení konfigurace. Argumenty keyFilter a labelFilter hodnoty klíčů lze zadat k filtrování hodnot klíčů na key základě a label v uvedeném pořadí. Další informace o filtrování najdete v tématu o dotazování nastavení konfigurace.

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

Uzamčení nastavení konfigurace

Stav zámku klíč-hodnota v App Configuration je označen readOnly atributem objektu ConfigurationSetting . Pokud readOnly ano true, nastavení je uzamčeno. Metodu setReadOnly lze vyvolat true jako druhý argument pro uzamčení nastavení konfigurace.

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

Odemknutí nastavení konfigurace

readOnly Pokud je falseatributem , ConfigurationSetting nastavení je odemknuté. Metodu setReadOnly lze vyvolat false jako druhý argument k odemknutí nastavení konfigurace.

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

Aktualizace nastavení konfigurace

Metodu setConfigurationSetting lze použít k aktualizaci existujícího nastavení nebo vytvoření nového nastavení. Následující fragment kódu změní hodnotu existujícího nastavení konfigurace.

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

Odstranění nastavení konfigurace

Následující fragment kódu odstraní nastavení konfigurace podle key názvu.

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

Spustit aplikaci

V tomto příkladu jste vytvořili aplikaci Node.js, která používá klientskou knihovnu Aplikace Azure Configuration k načtení nastavení konfigurace vytvořeného prostřednictvím webu Azure Portal, přidání nového nastavení, načtení seznamu existujících nastavení, uzamčení a odemknutí nastavení, aktualizaci nastavení a nakonec odstranění nastavení.

V tomto okamžiku by měl mít soubor app-configuration-example.js následující kód:

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

V okně konzoly přejděte do adresáře obsahujícího soubor app-configuration-example.js a spusťte aplikaci spuštěním následujícího příkazu:

node app.js

Měl by se zobrazit následující výstup:

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!

Vyčištění prostředků

Pokud nechcete dál používat prostředky vytvořené v tomto článku, odstraňte skupinu prostředků, kterou jste tady vytvořili, abyste se vyhnuli poplatkům.

Důležité

Odstranění skupiny prostředků je nevratné. Skupina prostředků a všechny prostředky v ní se trvale odstraní. Ujistěte se, že omylem neodstraníte nesprávnou skupinu prostředků nebo prostředky. Pokud jste vytvořili prostředky pro tento článek ve skupině prostředků, která obsahuje další prostředky, které chcete zachovat, odstraňte jednotlivé prostředky z příslušného podokna místo odstranění skupiny prostředků.

1. Přihlaste se k webu Azure Portal a vyberte skupiny prostředků.
2. Do pole Filtrovat podle názvu zadejte název vaší skupiny prostředků.
3. V seznamu výsledků vyberte název skupiny prostředků, abyste zobrazili přehled.
4. Vyberte Odstranit skupinu prostředků.
5. Zobrazí se výzva k potvrzení odstranění skupiny prostředků. Potvrďte název skupiny prostředků a vyberte Odstranit.

Po chvíli se skupina prostředků a všechny její prostředky odstraní.

Další kroky

Tato příručka vám ukázala, jak pomocí sady Azure SDK pro JavaScript přistupovat k hodnotám klíčů v konfiguraci Aplikace Azure.

Další ukázky kódu najdete zde:

Ukázky klientské knihovny Aplikace Azure Konfigurace

Pokud chcete zjistit, jak používat Aplikace Azure Konfigurace s aplikacemi v JavaScriptu, přejděte na:

Vytvoření javascriptové aplikace s konfigurací Aplikace Azure