Membuat aplikasi Node.js dengan Azure SDK untuk JavaScript

Dokumen ini memperlihatkan contoh cara menggunakan Azure SDK untuk JavaScript untuk mengakses nilai kunci di Azure App Configuration.

Tip

App Configuration menawarkan pustaka penyedia JavaScript yang dibangun di atas JavaScript SDK dan dirancang agar lebih mudah digunakan dengan fitur yang lebih kaya. Ini memungkinkan pengaturan konfigurasi digunakan seperti objek Peta, dan menawarkan fitur lain seperti komposisi konfigurasi dari beberapa label, pemangkasan nama kunci, dan resolusi otomatis referensi Key Vault. Buka mulai cepat JavaScript untuk mempelajari selengkapnya.

Prasyarat

• Akun Azure dengan langganan aktif - Buat akun secara gratis
• Penyimpanan App Configuration. Buat toko.
• Versi LTS dari Node.js. Untuk informasi tentang menginstal Node.js baik secara langsung di Windows atau menggunakan Subsistem Windows untuk Linux (WSL), lihat Memulai dengan Node.js

Membuat nilai kunci

Tambahkan nilai kunci berikut ke penyimpanan App Configuration dan biarkan Label dan Tipe Konten dengan nilai defaultnya. Untuk informasi selengkapnya tentang cara menambahkan nilai kunci ke penyimpanan menggunakan portal Azure atau CLI, buka Membuat nilai kunci.

Tombol	Nilai
TestApp:Pengaturan:Pesan	Data dari Azure App Configuration

Menyiapkan aplikasi Node.js

1. Dalam tutorial ini, Anda akan membuat direktori baru untuk proyek bernama app-configuration-example.

   mkdir app-configuration-example
   

2. Beralih ke direktori app-configuration-example yang baru dibuat.

   cd app-configuration-example
   

3. Instal pustaka klien Azure App Configuration dengan menggunakan perintah npm install.

   npm install @azure/app-configuration
   

4. Buat file baru yang disebut app-configuration-example.js di direktori app-configuration-example dan tambahkan kode berikut:

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

Catatan

Cuplikan kode dalam contoh ini akan membantu Anda memulai pustaka klien App Configuration untuk JavaScript. Untuk aplikasi Anda, Anda juga harus mempertimbangkan menangani pengecualian sesuai dengan kebutuhan Anda. Untuk mempelajari selengkapnya tentang penanganan pengecualian, lihat dokumentasi JavaScript SDK kami.

Mengonfigurasi string koneksi App Configuration Anda

1. Atur variabel lingkungan bernama AZURE_APPCONFIG_CONNECTION_STRING, dan atur ke string koneksi penyimpanan App Configuration Anda. Pada baris perintah, jalankan perintah berikut ini:

   Prompt perintah Windows

   Untuk menjalankan aplikasi secara lokal menggunakan perintah Windows, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:

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

   PowerShell

   Jika Anda menggunakan Windows PowerShell, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:

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

   macOS

   Jika Anda menggunakan macOS, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:

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

   Linux

   Jika Anda menggunakan Linux, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:

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

2. Cetak nilai variabel lingkungan untuk memvalidasi bahwa variabel diatur dengan benar dengan perintah di bawah ini.

   Prompt perintah Windows

   Dengan menggunakan prompt perintah Windows, mulai ulang perintah untuk memungkinkan perubahan diterapkan dan jalankan perintah berikut:

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Jika Anda menggunakan PowerShell Windows, jalankan perintah berikut:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   Jika Anda menggunakan macOS, jalankan perintah berikut:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Jika Anda menggunakan Linux, jalankan perintah berikut:

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

Sampel kode

Cuplikan kode sampel di bagian ini menunjukkan kepada Anda cara melakukan operasi umum dengan pustaka klien App Configuration untuk JavaScript. Tambahkan cuplikan kode ini ke isi run fungsi dalam file app-configuration-example.js yang Anda buat sebelumnya.

Catatan

Pustaka klien App Configuration mengacu pada objek kunci-nilai sebagai ConfigurationSetting. Oleh karena itu, dalam artikel ini, kunci-nilai di penyimpanan App Configuration akan disebut sebagai pengaturan konfigurasi.

Pelajari cara:

• Tersambung ke Penyimpanan App Configuration
• Mendapatkan pengaturan konfigurasi
• Menambahkan pengaturan konfigurasi
• Mendapatkan daftar pengaturan konfigurasi
• Mengunci pengaturan konfigurasi
• Membuka kunci pengaturan konfigurasi
• Memperbarui pengaturan konfigurasi
• Menghapus pengaturan konfigurasi

Tersambung ke Penyimpanan App Configuration

Cuplikan kode berikut membuat instans AppConfigurationClient menggunakan string koneksi yang disimpan dalam variabel lingkungan Anda.

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

Mendapatkan pengaturan konfigurasi

Cuplikan kode berikut mengambil pengaturan konfigurasi menurut nama key.

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

Menambahkan pengaturan konfigurasi

Cuplikan kode berikut membuat objek ConfigurationSetting dengan bidang key dan value serta mengaktifkan metode addConfigurationSetting. Metode ini akan memberikan pengecualian jika Anda mencoba menambahkan pengaturan konfigurasi yang telah ada dalam penyimpanan Anda. Jika Anda ingin menghindari pengecualian ini, metode setConfigurationSetting dapat digunakan sebagai gantinya.

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

Mendapatkan daftar pengaturan konfigurasi

Cuplikan kode berikut mengambil daftar pengaturan konfigurasi. Argumen keyFilter dan labelFilter dapat disediakan untuk memfilter kunci-nilai berdasarkan masing-masing key dan label. Untuk informasi selengkapnya tentang pemfilteran, lihat cara melakukan kueri pengaturan konfigurasi.

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

Mengunci pengaturan konfigurasi

Status kunci dari kunci-nilai dalam App Configuration ditandai dengan atribut readOnly dari objek ConfigurationSetting. Jika readOnly adalah true, maka pengaturan terkunci. Metode setReadOnly ini dapat dipanggil dengan true sebagai argumen kedua untuk mengunci pengaturan konfigurasi.

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

Membuka kunci pengaturan konfigurasi

Jika atribut readOnly dari ConfigurationSetting adalah false, maka pengaturan tidak terkunci. Metode setReadOnly ini dapat dipanggil dengan false sebagai argumen kedua untuk membuka kunci pengaturan konfigurasi.

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

Memperbarui pengaturan konfigurasi

Metode setConfigurationSetting dapat digunakan untuk memperbarui pengaturan yang ada atau membuat pengaturan baru. Cuplikan kode berikut mengubah nilai pengaturan konfigurasi yang sudah ada.

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

Menghapus pengaturan konfigurasi

Cuplikan kode berikut menghapus pengaturan konfigurasi menurut nama key.

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

Menjalankan aplikasi

Dalam contoh ini, Anda membuat aplikasi Node.js yang menggunakan pustaka klien Azure App Configuration untuk mengambil pengaturan konfigurasi yang dibuat melalui portal Azure, menambahkan pengaturan baru, mengambil daftar pengaturan yang ada, mengunci dan membuka kunci pengaturan, memperbarui pengaturan, dan akhirnya menghapus pengaturan.

Pada titik ini, file app-configuration-example.js Anda harus memiliki kode berikut:

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

Di jendela konsol Anda, navigasikan ke direktori yang berisi file app-configuration-example.js dan jalankan perintah berikut untuk menjalankan aplikasi:

node app.js

Anda akan menemukan output berikut:

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!

Membersihkan sumber daya

Jika Anda tidak ingin terus menggunakan sumber daya yang dibuat dalam artikel ini, hapus grup sumber daya yang Anda buat di sini untuk menghindari biaya.

Penting

Penghapusan grup sumber daya tidak bisa dipulihkan. Grup sumber daya dan semua sumber daya yang ada di dalamnya akan dihapus secara permanen. Pastikan Anda tidak menghapus grup atau sumber daya yang salah secara tidak sengaja. Jika Anda membuat sumber daya untuk artikel ini dalam grup sumber daya yang ada yang berisi sumber daya lain yang ingin disimpan, hapus setiap sumber daya satu per satu dari panelnya masing-masing, bukan menghapus grup sumber daya.

1. Masuk ke portal Azure, lalu pilih Grup sumber daya.
2. Dalam kotak Filter menurut nama, masukkan nama grup sumber daya Anda.
3. Dalam daftar hasil, pilih nama grup sumber daya untuk melihat gambaran umum.
4. Pilih Hapus grup sumber daya.
5. Anda akan diminta untuk mengonfirmasi penghapusan grup sumber daya. Masukkan nama grup sumber daya Anda untuk mengonfirmasi, dan pilih Hapus.

Setelah beberapa saat, grup sumber daya dan semua sumber dayanya akan dihapus.

Langkah berikutnya

Panduan ini menunjukkan kepada Anda cara menggunakan Azure SDK for JavaScript untuk mengakses nilai kunci di Azure App Configuration.

Untuk sampel kode tambahan, kunjungi:

Sampel pustaka klien Azure App Configuration

Untuk mempelajari cara menggunakan Azure App Configuration dengan aplikasi JavaScript, buka:

Membuat aplikasi JavaScript dengan Azure App Configuration