編輯

共用方式為

設定 Azure Static Web Apps 的應用程式設定

  • 操作方式

應用程式設定會保留可能需變更的設定值，例如資料庫連接字串。 新增應用程式設定可讓您修改應用程式的設定輸入，而不需要變更應用程式程式碼。

應用程式設定：

  • 可作為靜態 Web 應用程式的後端 API 環境變數
  • 可儲存用於驗證組態的秘密
  • 會進行待用加密
  • 會複製到預備和實際執行環境
  • 可以只包含英數字元、. 和 _

重要

本文所述的應用程式設定僅適用於 Azure Static Web App 的後端 API。

若要設定組建前端 Web 應用程式時所需的環境變數，請參閱組建組態。

必要條件

  • Azure Static Web Apps 應用程式
  • Azure CLI - 必要項目 (如果您使用命令列)

設定本機開發的 API 應用程式設定

Azure Static Web Apps 中的 API 是由 Azure Functions 提供，當您在本機上執行應用程式時，後者可讓您在 local.settings.json 檔案中定義應用程式設定。 此檔案會在設定的 Values 屬性中定義應用程式設定。

注意

「local.settings.json」檔案僅適用於本機開發。 使用 Azure 入口網站來設定實際執行環境的應用程式設定。

下列的範例 local.settings.json 顯示如何為 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.

設定應用程式設定

您可以透過 Azure 入口網站或 Azure CLI 來設定應用程式設定。

使用 Azure 入口網站

Azure 入口網站提供的介面可用來建立、更新、刪除應用程式設定。

  1. 前往 Azure 入口網站。

  2. 開啟您的靜態 Web 應用程式。

  3. 選取側邊欄中的 [環境變數]。

  4. 選取您要建立環境變數的環境。 您可以為每個環境建立變數。 當您建立提取要求時，會自動建立預備環境，並會在合併提取要求之後，升級為實際執行環境。

  5. 選取 [+ 新增] 以新增環境變數。 Azure Static Web Apps 環境變數檢視的螢幕擷取畫面

  6. 輸入名稱和值。

  7. 選取 [確定]。

  8. 選取 [儲存]。

使用 Azure CLI

使用 az staticwebapp appsettings 命令來更新 Azure 中的設定。

在終端或命令列中執行下列命令，來新增或更新名為 message 且具有 Hello world 值的設定。 請務必將預留位置 <YOUR_APP_ID> 取代為您的值。

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.

相關內容