Edit

Bagikan melalui

Mengonfigurasi pengaturan aplikasi untuk Azure Static Web Apps

  • Bagaimana

Pengaturan aplikasi menyimpan nilai konfigurasi yang dapat berubah, seperti string koneksi database. Menambahkan pengaturan aplikasi memungkinkan Anda memodifikasi input konfigurasi ke aplikasi, tanpa harus mengubah kode aplikasi.

Pengaturan aplikasi:

  • Tersedia sebagai variabel lingkungan ke API backend dari aplikasi web statis
  • Dapat digunakan untuk menyimpan rahasia yang digunakan dalam konfigurasi autentikasi
  • Dienkripsi saat tidak aktif
  • Disalin ke penahapan dan lingkungan produksi
  • Hanya boleh berupa karakter alfanumerik, ., dan _

Penting

Pengaturan aplikasi yang dijelaskan dalam artikel ini hanya berlaku untuk API backend Azure Static Web App.

Untuk mengonfigurasi variabel lingkungan yang diperlukan untuk membangun aplikasi web frontend Anda, lihat Bangun konfigurasi.

Prasyarat

  • Aplikasi Azure Static Web Apps
  • Azure CLI diperlukan jika Anda menggunakan baris perintah

Mengonfigurasi pengaturan aplikasi API untuk pengembangan lokal

API di Azure Static Web Apps didukung oleh Azure Functions, yang memungkinkan Anda menentukan pengaturan aplikasi dalam file local.settings.json saat Anda menjalankan aplikasi secara lokal. File ini menentukan pengaturan aplikasi di properti Values konfigurasi.

Catatan

File local.settings.json hanya digunakan untuk pengembangan lokal. Gunakan portal Microsoft Azure untuk mengonfigurasi pengaturan aplikasi untuk produksi.

Sampel local.settings.json berikut menunjukkan cara menambahkan nilai untuk DATABASE_CONNECTION_STRING.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "DATABASE_CONNECTION_STRING": "<YOUR_DATABASE_CONNECTION_STRING>"
  }
}

Settings defined in the Values property can be referenced from code as environment variables. In Node.js functions, for example, they're available in the process.env object.

const connectionString = process.env.DATABASE_CONNECTION_STRING;

The local.settings.json file isn't tracked by the GitHub repository because sensitive information, like database connection strings, are often included in the file. Since the local settings remain on your machine, you need to manually configure your settings in Azure.

Generally, configuring your settings is done infrequently, and isn't required with every build.

Mengonfigurasi pengaturan aplikasi

Anda dapat mengonfigurasi pengaturan aplikasi melalui portal Azure atau dengan Azure CLI.

Menggunakan portal Azure

Portal Azure menyediakan antarmuka untuk membuat, memperbarui, dan menghapus pengaturan aplikasi.

  1. Buka portal Microsoft Azure.

  2. Buka aplikasi web statis Anda.

  3. Pilih Variabel lingkungan di bar samping.

  4. Pilih lingkungan tempat Anda ingin membuat variabel lingkungan. Anda dapat membuat variabel per lingkungan. Saat Anda membuat permintaan pull, lingkungan penahapan dibuat secara otomatis, lalu dipromosikan ke produksi saat Anda menggabungkan permintaan pull.

  5. Pilih + Tambahkan untuk menambahkan variabel lingkungan baru. Cuplikan layar tampilan variabel lingkungan Azure Static Web Apps

  6. Masukkan Nama dan Nilai.

  7. Pilih OK.

  8. Pilih Simpan.

Menggunakan Azure CLI

az staticwebapp appsettings Gunakan perintah untuk memperbarui pengaturan Anda di Azure.

Di terminal atau baris perintah, jalankan perintah berikut untuk menambahkan atau memperbarui pengaturan bernama message dengan nilai Hello world. Pastikan untuk mengganti placeholder <YOUR_APP_ID> dengan nilai Anda.

az staticwebapp appsettings set --name <YOUR_APP_ID> --setting-names "message=Hello world"

Tip

You can add or update multiple settings by passing multiple name-value pairs to --setting-names.

View application settings with the Azure CLI

In a terminal or command line, execute the following command. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings list --name <YOUR_APP_ID>

Delete application settings with the Azure CLI

In a terminal or command line, execute the following command to delete a setting named message. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings delete --name <YOUR_APP_ID> --setting-names "message"

Tip

Delete multiple settings by passing multiple setting names to --setting-names.

Konten terkait