Node.js-alkalmazás létrehozása a JavaScripthez készült Azure SDK-val

Ez a dokumentum példákat mutat be arra, hogyan használhatja a JavaScripthez készült Azure SDK-t a kulcsértékek elérésére Azure-alkalmazás Konfigurációban.

Tipp.

Az Alkalmazáskonfiguráció egy JavaScript-szolgáltatói kódtárat kínál, amely a JavaScript SDK-ra épül, és úgy van kialakítva, hogy könnyebben használható legyen a gazdagabb funkciókkal. Lehetővé teszi, hogy a konfigurációs beállításokat térképobjektumként használják, és más funkciókat is kínál, például a több címkéből álló konfigurációösszeállítást, a kulcsnév-vágást és a Key Vault-hivatkozások automatikus felbontását. További információért nyissa meg a JavaScript gyorsútmutatót .

Előfeltételek

• Azure-fiók aktív előfizetéssel – Hozzon létre egyet ingyenesen
• Alkalmazáskonfigurációs áruház. Hozzon létre egy áruházat.
• A Node.js LTS-verziói. További információ a Node.js telepítéséről közvetlenül a Windows rendszeren vagy a Linuxos Windows-alrendszer (WSL) használatával kapcsolatban: Ismerkedés a Node.js szolgáltatással

Kulcs-érték létrehozása

Adja hozzá a következő kulcsértéket az Alkalmazáskonfigurációs áruházhoz, és hagyja meg a címke és a tartalomtípus alapértelmezett értékeit. Ha többet szeretne tudni arról, hogyan adhat hozzá kulcsértékeket egy áruházhoz az Azure Portal vagy a parancssori felület használatával, lépjen a Kulcs-érték létrehozása elemre.

Key	Érték
TestApp:Gépház:Message	Adatok Azure-alkalmazás konfigurációjából

A Node.js alkalmazás beállítása

1. Ebben az oktatóanyagban egy új könyvtárat fog létrehozni az alkalmazáskonfigurációs példa nevű projekthez.

   mkdir app-configuration-example
   

2. Váltson az újonnan létrehozott alkalmazáskonfigurációs példakönyvtárra .

   cd app-configuration-example
   

3. Telepítse a Azure-alkalmazás konfigurációs ügyfélkódtárat a npm install parancs használatával.

   npm install @azure/app-configuration
   

4. Hozzon létre egy app-configuration-example.js nevű új fájlt az app-configuration-example könyvtárban, és adja hozzá a következő kódot:

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

Megjegyzés:

A példában szereplő kódrészletek segítenek a JavaScript alkalmazáskonfigurációs ügyfélkódtárának használatbavételében. Az alkalmazás esetében érdemes megfontolnia a kivételek igény szerinti kezelését is. A kivételkezeléssel kapcsolatos további információkért tekintse meg a JavaScript SDK dokumentációját.

Az alkalmazáskonfigurációs kapcsolati sztring konfigurálása

1. Állítson be egy AZURE_APPCONFIG_CONNECTION_STRING nevű környezeti változót, és állítsa be az Alkalmazáskonfigurációs áruház kapcsolati sztring. Futtassa a következő parancsot a parancssorban:

   Windows parancssor

   Ha helyileg szeretné futtatni az alkalmazást a Windows parancssorával, futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:

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

   PowerShell

   Windows PowerShell használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:

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

   macOS

   MacOS használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:

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

   Linux

   Linux használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:

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

2. Nyomtassa ki a környezeti változó értékét annak ellenőrzéséhez, hogy megfelelően van-e beállítva az alábbi paranccsal.

   Windows parancssor

   A Windows parancssorával indítsa újra a parancssort a módosítás érvénybe lépésének engedélyezéséhez, és futtassa a következő parancsot:

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Windows PowerShell használata esetén futtassa a következő parancsot:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   MacOS használata esetén futtassa a következő parancsot:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Linux használata esetén futtassa a következő parancsot:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Code samples

Az ebben a szakaszban található mintakódrészletek bemutatják, hogyan hajthat végre gyakori műveleteket a JavaScript alkalmazáskonfigurációs ügyfélkódtárával. Adja hozzá ezeket a kódrészleteket a függvény törzséhez run a korábban létrehozott app-configuration-example.js fájlban.

Megjegyzés:

Az Alkalmazáskonfiguráció ügyfélkódtár egy kulcs-érték objektumra hivatkozik.ConfigurationSetting Ezért ebben a cikkben az App Configuration Store kulcsértékei konfigurációs beállításoknak lesznek nevezve.

Az alábbiakban megtudhatja, hogyan:

• Csatlakozás alkalmazáskonfigurációs áruházba
• Konfigurációs beállítás lekérése
• Konfigurációs beállítás hozzáadása
• Konfigurációs beállítások listájának lekérése
• Konfigurációs beállítás zárolása
• Konfigurációs beállítás zárolásának feloldása
• Konfigurációs beállítás frissítése
• Konfigurációs beállítás törlése

Csatlakozás alkalmazáskonfigurációs áruházba

Az alábbi kódrészlet létrehozza az AppConfigurationClient egy példányát a környezeti változókban tárolt kapcsolati sztring használatával.

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

Konfigurációs beállítás lekérése

Az alábbi kódrészlet név szerint key kéri le a konfigurációs beállítást.

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

Konfigurációs beállítás hozzáadása

Az alábbi kódrészlet létrehoz egy ConfigurationSetting objektumot és value mezőket, key és meghívja a metódustaddConfigurationSetting. Ez a módszer kivételt eredményez, ha olyan konfigurációs beállítást próbál hozzáadni, amely már létezik az áruházban. Ha el szeretné kerülni ezt a kivételt, a setConfigurationSetting metódus használható helyette.

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

Konfigurációs beállítások listájának lekérése

Az alábbi kódrészlet lekéri a konfigurációs beállítások listáját. Az keyFilter és labelFilter az argumentumok megadhatóak a kulcsértékek alapján és label azok alapján key történő szűréséhez. A szűrésről további információt a konfigurációs beállítások lekérdezésével kapcsolatban talál.

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

Konfigurációs beállítás zárolása

Az Alkalmazáskonfiguráció kulcsértékének zárolási állapotát az readOnlyConfigurationSetting objektum attribútuma jelöli. Ha readOnly igen true, a beállítás zárolva van. A setReadOnly metódus második argumentumként meghívható true a konfigurációs beállítás zárolásához.

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

Konfigurációs beállítás zárolásának feloldása

Ha egy readOnly attribútum ConfigurationSetting egy, falsea beállítás feloldva. A setReadOnly metódus meghívható false második argumentumként a konfigurációs beállítás feloldásához.

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

Konfigurációs beállítás frissítése

A setConfigurationSetting metódus egy meglévő beállítás frissítésére vagy új beállítás létrehozására használható. Az alábbi kódrészlet megváltoztatja egy meglévő konfigurációs beállítás értékét.

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

Konfigurációs beállítás törlése

Az alábbi kódrészlet név szerint key törli a konfigurációs beállítást.

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

Az alkalmazás futtatása

Ebben a példában létrehozott egy Node.js-alkalmazást, amely a Azure-alkalmazás Configuration ügyfélkódtár használatával lekéri az Azure Portalon létrehozott konfigurációs beállítást, új beállítást ad hozzá, lekéri a meglévő beállítások listáját, zárolja és feloldja a beállításokat, frissít egy beállítást, és végül töröl egy beállítást.

Ezen a ponton az app-configuration-example.js fájlnak a következő kóddal kell rendelkeznie:

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

A konzolablakban keresse meg az app-configuration-example.js fájlt tartalmazó könyvtárat, és futtassa a következő parancsot az alkalmazás futtatásához:

node app.js

A következő kimenetnek kell megjelennie:

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!

Clean up resources

Ha nem szeretné folytatni a cikkben létrehozott erőforrások használatát, törölje az itt létrehozott erőforráscsoportot a díjak elkerülése érdekében.

Fontos

Az erőforráscsoport törlése nem vonható vissza. Az erőforráscsoport és a benne lévő összes erőforrás véglegesen törlődik. Győződjön meg arról, hogy nem véletlenül törli a rossz erőforráscsoportot vagy erőforrásokat. Ha a cikk erőforrásait olyan erőforráscsoporton belül hozta létre, amely más megtartani kívánt erőforrásokat tartalmaz, törölje az egyes erőforrásokat a megfelelő panelről az erőforráscsoport törlése helyett.

1. Jelentkezzen be az Azure Portalra, és válassza ki az Erőforráscsoportokat.
2. A Szűrés név szerint mezőbe írja be az erőforráscsoport nevét.
3. Az eredménylistában válassza ki az erőforráscsoport nevét az áttekintés megtekintéséhez.
4. Válassza az Erőforráscsoport törlése elemet.
5. A rendszer az erőforráscsoport törlésének megerősítését kéri. Adja meg a megerősítéshez az erőforráscsoport nevét, és válassza a Törlés lehetőséget.

Néhány pillanat múlva az erőforráscsoport és annak összes erőforrása törlődik.

További lépések

Ez az útmutató bemutatta, hogyan érheti el a kulcsértékeket a JavaScripthez készült Azure SDK-val Azure-alkalmazás konfigurációban.

További kódmintákért látogasson el a következőre:

Azure-alkalmazás Konfigurációs ügyfélkódtár mintái

A Azure-alkalmazás-konfiguráció JavaScript-alkalmazásokkal való használatáról a következő témakörben tájékozódhat:

JavaScript-alkalmazás létrehozása Azure-alkalmazás konfigurációval