你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

使用 Azure Static Web Apps CLI 部署静态 Web 应用

  • 项目

命令deploy将当前项目部署到Azure Static Web Apps。

一些常见用例包括：

  • 在没有 API 的情况下部署前端应用
  • 使用 API 部署前端应用
  • 部署 Blazor 应用

部署令牌

SWA CLI 支持使用部署令牌进行部署。 从 CI/CD 环境部署时，这通常很有用。 可以从以下任一获取部署令牌：

  • Azure 门户：主页→静态 Web 应用→实例→概述→管理部署令牌

  • 如果使用 Azure CLI，可以使用以下命令获取项目的部署令牌：

az staticwebapp secrets list --name <APPLICATION_NAME> --query "properties.apiKey"
  • 如果使用 Azure Static Web Apps CLI，可以使用以下命令：
swa deploy --print-token

然后，可以将该值与 一起使用， --deployment-token <token> 也可以创建名为 的 SWA_CLI_DEPLOYMENT_TOKEN 环境变量并将其设置为部署令牌。

重要

不要将部署令牌存储在公共存储库中。

在没有 API 的情况下部署前端应用

可以通过运行以下步骤将没有 API 的前端应用程序部署到Azure Static Web Apps：

如果前端应用程序需要生成步骤，请运行 swa build 或参考应用程序生成说明。

  • 选项 1： 从要部署的生成文件夹中，运行 deploy 命令：

    cd build/
swa deploy

    注意

    生成文件夹必须包含要部署的应用的静态内容。

  • 选项 2： 还可以部署特定文件夹：

    1. 如果前端应用程序需要生成步骤，请运行 swa build 或参考应用程序生成说明。

    2. 部署应用：

    swa deploy ./my-dist

使用 API 部署前端应用

若要将前端应用和 API 部署到Azure Static Web Apps，请使用以下步骤。

  1. 如果前端应用程序需要生成步骤，请运行 swa build 或参考应用程序生成说明。

  2. 请确保 正确设置staticwebapp.config.json 文件中的 API 语言运行时版本，例如：

{
  "platform": {
    "apiRuntime": "node:16"
  }
}

注意

如果项目没有 staticwebapp.config.json 文件，请在 outputLocation 文件夹下添加一个文件。

  1. 部署应用：
swa deploy ./my-dist --api-location ./api

部署 Blazor 应用

若要使用 API 部署 Blazor 应用以Azure Static Web Apps，请执行以下步骤：

  1. 在 发布 模式下生成 Blazor 应用：
dotnet publish -c Release -o bin/publish
  1. 从项目的根目录中，运行 deploy 命令：
swa deploy ./bin/publish/wwwroot --api-location ./Api

使用 部署 swa-cli.config.json

注意

的路径 outputLocation 必须相对于 appLocation。

如果在项目中使用 swa-cli.config.json 配置文件，并且具有单个配置条目，例如：

{
  "configurations": {
    "my-app": {
      "appLocation": "./",
      "apiLocation": "api",
      "outputLocation": "frontend",
      "start": {
        "outputLocation": "frontend"
      },
      "deploy": {
        "outputLocation": "frontend"
      }
    }
  }
}

然后，可以通过运行以下命令来部署应用程序：

  1. 如果前端应用程序需要生成步骤，请运行 swa build 或参考应用程序生成说明。

  2. 部署应用：

swa deploy

如果有多个配置条目，可以提供条目 ID 来指定要使用的条目 ID：

swa deploy my-otherapp

选项

下面是可用于 swa deploy的选项：

  • -a, --app-location <path>：包含前端应用程序源代码的文件夹 (默认值：“.”)
  • -i, --api-location <path>：包含 API 应用程序的源代码的文件夹
  • -O, --output-location <path>：包含前端应用程序的生成源的文件夹。 路径相对于 --app-location (默认值：“.”)
  • -w, --swa-config-location <swaConfigLocation>：staticwebapp.config.json 文件所在的目录
  • -d, --deployment-token <secret>：用于向Static Web Apps进行身份验证的机密令牌
  • -dr, --dry-run：模拟部署过程而不实际运行它 (默认值： false)
  • -pt, --print-token：打印部署令牌 (默认值： false)
  • --env [environment]：要在其中部署项目的部署环境的类型 (默认值：“preview”)
  • -S, --subscription-id <subscriptionId>：此项目使用的 Azure 订阅 ID (默认值： process.env.AZURE_SUBSCRIPTION_ID)
  • -R, --resource-group <resourceGroupName>：此项目使用的 Azure 资源组
  • -T, --tenant-id <tenantId>：Azure 租户 ID (默认值： process.env.AZURE_TENANT_ID)
  • -C, --client-id <clientId>：Azure 客户端 ID
  • -CS, --client-secret <clientSecret>：Azure 客户端密码
  • -n, --app-name <appName>：Azure Static Web App 应用程序名称
  • -cc, --clear-credentials：清除登录前保留的凭据 (默认值： false)
  • -u, --use-keychain：启用对持久性凭据使用操作系统本机密钥链 (默认值： true)
  • -nu, --no-use-keychain：使用操作系统本机密钥链禁用
  • -h, --help：显示命令的帮助

使用情况

使用部署令牌进行部署。

swa deploy ./dist/ --api-location ./api/ --deployment-token <TOKEN>

使用环境变量中的部署令牌进行部署。

SWA_CLI_DEPLOYMENT_TOKEN=123 swa deploy ./dist/ --api-location ./api/

使用 swa-cli.config.json 文件进行部署

swa deploy
swa deploy myconfig

打印部署令牌。

swa deploy --print-token

部署到特定环境。

swa deploy --env production