設定 Azure Static Web Apps CLI

重要

為了改善靜態 Web Apps CLI 部署的安全性，引進了重大變更，要求您在 2025 年 1 月 15 日之前升級至最新版的靜態 Web Apps CLI。

Azure Static Web Apps （SWA） CLI 會以下列兩種方式之一取得靜態 Web 應用程式的組態資訊：

• CLI 選項 （在執行時間傳入）
• 名為 swa-cli.config.json 的 CLI 組態檔

注意

根據預設，SWA CLI 會在目前目錄中尋找名為 swa-cli.config.json 的組態檔。

組態檔可以包含多個組態，每個組態都是由唯一組態名稱所識別。

• 如果swa-cli.config.json檔案中只有單一組態存在，swa start則預設會使用它。

• 如果選項是從組態檔載入，則會忽略命令行選項。

範例設定檔

下列代碼段顯示組態檔的形狀。

{
  "configurations": {
    "app": {
      "appDevserverUrl": "http://localhost:3000",
      "apiLocation": "api",
      "run": "npm run start",
      "swaConfigLocation": "./my-app-source"
    }
  }
}

當您只有一個組態區段時，如本範例所示，命令 swa start 會自動使用這些值。

初始化組態檔

您可以使用 命令來初始化組態檔 swa init 。 如果您針對現有的項目執行命令，則 swa init 嘗試猜測您設定的組態設定。

根據預設，程式會在您專案的目前工作目錄中，於 swa-cli.config.json 中建立這些設定。 此目錄是搜尋項目組態值時所使用的 swa 預設檔名和位置。

swa --config <PATH>

如果檔案只包含一個具名組態，則預設會使用該組態。 如果定義了多個組態，則您會將所需的組態名稱傳遞為選項。

swa --<CONFIG_NAME>

使用組態檔選項時，設定會以 JSON 格式儲存。 建立之後，您可以手動編輯檔案以更新設定，或使用 swa init 進行更新。

檢視設定

Static Webs CLI 提供 --print-config 選項，讓您檢閱目前的組態。

以下是在具有預設設定的新項目上執行時，該輸出的外觀範例。

swa --print-config

Options:
 - port: 4280
 - host: localhost
 - apiPort: 7071
 - appLocation: .
 - apiLocation: <undefined>
 - outputLocation: .
 - swaConfigLocation: <undefined>
 - ssl: false
 - sslCert: <undefined>
 - sslKey: <undefined>
 - appBuildCommand: <undefined>
 - apiBuildCommand: <undefined>
 - run: <undefined>
 - verbose: log
 - serverTimeout: 60
 - open: false
 - githubActionWorkflowLocation: <undefined>
 - env: preview
 - appName: <undefined>
 - dryRun: false
 - subscriptionId: <undefined>
 - resourceGroupName: <undefined>
 - tenantId: <undefined>
 - clientId: <undefined>
 - clientSecret: <undefined>
 - useKeychain: true
 - clearCredentials: false
 - config: swa-cli.config.json
 - printConfig: true

執行 swa --print-config 提供目前的組態預設值。

注意

如果專案尚未定義組態檔，這會自動觸發 swa init 工作流程以協助您建立組態檔。

驗證設定

您可以針對下列架構驗證 swa-cli.config.json 檔案： https://aka.ms/azure/static-web-apps-cli/schema