Aracılığıyla paylaş


JavaScript için Azure SDK ile Node.js uygulaması oluşturma

Bu belgede, Azure Uygulaması Yapılandırmasında anahtar-değerlere erişmek için JavaScript için Azure SDK'nın nasıl kullanılacağına ilişkin örnekler gösterilmektedir.

Önemli

Uygulama Yapılandırması, JavaScript SDK'sının üzerine kurulmuş ve daha zengin özelliklerle kullanımı daha kolay olacak şekilde tasarlanmış bir JavaScript sağlayıcı kitaplığı sunar. Yapılandırma ayarlarının Bir Harita nesnesi gibi kullanılmasını sağlar ve birden çok etiketten yapılandırma oluşturma, anahtar adı kırpma ve Key Vault başvurularının otomatik çözünürlüğü gibi diğer özellikleri sunar. Daha fazla bilgi edinmek için JavaScript hızlı başlangıcına gidin.

Önkoşullar

Anahtar-değer oluşturma

Uygulama Yapılandırması deposuna aşağıdaki anahtar değerini ekleyin ve Etiket ve İçerik Türü değerlerini varsayılan değerleriyle bırakın. Azure portalını veya CLI'yı kullanarak bir depoya anahtar-değer ekleme hakkında daha fazla bilgi için Anahtar-değer oluşturma bölümüne gidin.

Anahtar Değer
TestApp:Ayarlar:İleti Azure Uygulaması Yapılandırmasından Veriler

Node.js uygulamasını ayarlama

  1. Bu öğreticide, proje için app-configuration-example adlı yeni bir dizin oluşturacaksınız.

    mkdir app-configuration-example
    
  2. Yeni oluşturulan app-configuration-example dizinine geçin.

    cd app-configuration-example
    
  3. komutunu kullanarak Azure Uygulaması Yapılandırması istemci kitaplığını npm install yükleyin.

    npm install @azure/app-configuration
    
  4. app-configuration-example dizininde app-configuration-example.js adlı yeni bir dosya oluşturun ve aşağıdaki kodu ekleyin:

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

Not

Bu örnekteki kod parçacıkları JavaScript için Uygulama Yapılandırması istemci kitaplığını kullanmaya başlamanıza yardımcı olacaktır. Uygulamanız için özel durumları gereksinimlerinize göre işlemeyi de göz önünde bulundurmanız gerekir. Özel durum işleme hakkında daha fazla bilgi edinmek için lütfen JavaScript SDK belgelerimize bakın.

Kod örnekleri

Bu bölümdeki örnek kod parçacıkları, JavaScript için Uygulama Yapılandırması istemci kitaplığıyla ortak işlemlerin nasıl gerçekleştirileceğini gösterir. Bu kod parçacıklarını daha önce oluşturduğunuz app-configuration-example.js dosyasındaki işlevin rungövdesine ekleyin.

Not

Uygulama Yapılandırması istemci kitaplığı, anahtar-değer nesnesine olarak ConfigurationSettingbaşvurur. Bu nedenle, bu makalede, Uygulama Yapılandırması deposundaki anahtar-değerler yapılandırma ayarları olarak adlandırılır.

Aşağıdakilerin nasıl yapılacağını öğrenin:

Uygulama Yapılandırması deposuna bağlanma

Aşağıdaki kod parçacığı bir AppConfigurationClient örneği oluşturur. Microsoft Entra Id (önerilen) veya bir bağlantı dizesi kullanarak Uygulama Yapılandırması mağazanıza bağlanabilirsiniz.

Uygulama Yapılandırması deponuzda kimlik doğrulaması yapmak için öğesini kullanırsınızDefaultAzureCredential. Kimlik bilgilerinizi Uygulama Yapılandırması Veri Okuyucusu rolü atamak için yönergeleri izleyin. Uygulamanızı çalıştırmadan önce iznin yayılması için yeterli süreye izin verdiğinden emin olun.

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

const client = new AppConfigurationClient(
  process.env.AZURE_APPCONFIG_ENDPOINT,
  new DefaultAzureCredential()
);

Yapılandırma ayarı alma

Aşağıdaki kod parçacığı ada göre key bir yapılandırma ayarı alır.

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

Yapılandırma ayarı ekleme

Aşağıdaki kod parçacığı ve ConfigurationSetting alanlarıyla key bir value nesne oluşturur ve yöntemini çağırıraddConfigurationSetting. Deponuzda zaten var olan bir yapılandırma ayarı eklemeye çalışırsanız bu yöntem bir özel durum oluşturur. Bu özel durumdan kaçınmak istiyorsanız, bunun yerine setConfigurationSetting yöntemi kullanılabilir.

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

Yapılandırma ayarlarının listesini alma

Aşağıdaki kod parçacığı yapılandırma ayarlarının listesini alır. keyFilter ve labelFilter bağımsız değişkenleri sırasıyla ve key temelinde label anahtar-değerleri filtrelemek için sağlanabilir. Filtreleme hakkında daha fazla bilgi için bkz. Yapılandırma ayarlarını sorgulama.

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

Yapılandırma ayarını kilitleme

Uygulama Yapılandırması anahtar değerinin kilit durumu, nesnenin readOnlyConfigurationSetting özniteliğiyle belirtilir. ise readOnlytrue, ayar kilitlidir. yöntemi, setReadOnly yapılandırma ayarını kilitlemek için ikinci bağımsız değişken olarak ile true çağrılabilir.

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

Yapılandırma ayarının kilidini açma

readOnly özniteliği ConfigurationSetting ise falseayarın kilidi açılır. yöntemi, setReadOnly yapılandırma ayarının kilidini açmak için ikinci bağımsız değişken olarak ile false çağrılabilir.

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

Yapılandırma ayarını güncelleştirme

yöntemi setConfigurationSetting mevcut bir ayarı güncelleştirmek veya yeni bir ayar oluşturmak için kullanılabilir. Aşağıdaki kod parçacığı, mevcut yapılandırma ayarının değerini değiştirir.

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

Yapılandırma ayarını silme

Aşağıdaki kod parçacığı bir yapılandırma ayarını ada göre key siler.

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

Uygulamayı çalıştırma

Bu örnekte, Azure portalı aracılığıyla oluşturulan bir yapılandırma ayarını almak, yeni bir ayar eklemek, var olan ayarların listesini almak, bir ayarı kilitleyip kilidini açmak, bir ayarı güncelleştirmek ve son olarak bir ayarı silmek için Azure Uygulaması Yapılandırma istemci kitaplığını kullanan bir Node.js uygulaması oluşturdunuz.

Bu noktada, app-configuration-example.js dosyanızda aşağıdaki kod bulunmalıdır:

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

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

    const client = new AppConfigurationClient(
        process.env.AZURE_APPCONFIG_ENDPOINT,
        new DefaultAzureCredential()
    );

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

Ortam değişkeni yapılandırma

  1. Microsoft Entra Id (önerilen) veya bağlantı dizesi kullanarak bir ortam değişkeni yapılandırın.

    AZURE_APPCONFIG_ENDPOINT adlı bir ortam değişkenini Azure portalındaki mağazanıza genel bakış bölümünde bulunan Uygulama Yapılandırması deponuzun uç noktasına ayarlayın.

    Windows komut istemini kullanıyorsanız, aşağıdaki komutu çalıştırın ve değişikliğin etkili olması için komut istemini yeniden başlatın:

    setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
    

    PowerShell kullanıyorsanız aşağıdaki komutu çalıştırın:

    $Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
    

    macOS veya Linux kullanıyorsanız aşağıdaki komutu çalıştırın:

    export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
    
  2. Konsol pencerenizde, app-configuration-example.js dosyasını içeren dizine gidin ve aşağıdaki komutu yürüterek uygulamayı çalıştırın:

    node app.js
    

    Aşağıdaki çıkışı görmeniz gerekir:

    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!
    

Kaynakları temizleme

Bu makalede oluşturulan kaynakları kullanmaya devam etmek istemiyorsanız ücretlerden kaçınmak için burada oluşturduğunuz kaynak grubunu silin.

Önemli

Silinen kaynak grupları geri alınamaz. Kaynak grubu ve içindeki tüm kaynaklar kalıcı olarak silinir. Yanlış kaynak grubunu veya kaynakları yanlışlıkla silmediğinizden emin olun. Bu makalenin kaynaklarını, saklamak istediğiniz diğer kaynakları içeren bir kaynak grubu içinde oluşturduysanız, kaynak grubunu silmek yerine her kaynağı ilgili bölmeden tek tek silin.

  1. Azure portalında oturum açın ve Kaynak grupları'nı seçin.
  2. Ada göre filtrele kutusuna kaynak grubunuzun adını girin.
  3. Genel bir bakış görmek için sonuç listesinde kaynak grubu adını seçin.
  4. Kaynak grubunu sil'i seçin.
  5. Kaynak grubunun silinmesini onaylamanız istenir. Onaylamak için kaynak grubunuzun adını girin ve Sil'i seçin.

Birkaç dakika sonra kaynak grubu ve tüm kaynakları silinir.

Sonraki adımlar

Bu kılavuzda, Azure Uygulaması Yapılandırmasındaki anahtar değerlerine erişmek için JavaScript için Azure SDK'nın nasıl kullanılacağı gösterildi.

Ek kod örnekleri için şu adresi ziyaret edin:

JavaScript uygulamalarıyla Azure Uygulaması Yapılandırması'nı kullanmayı öğrenmek için şuraya gidin: