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

az staticwebapp

注意

此命令组具有在 Azure CLI 和至少一个扩展中定义的命令。 安装每个扩展，使其受益于其扩展功能。 详细了解扩展。

管理静态应用。

命令

名称	说明	类型	状态
az staticwebapp appsettings	管理静态应用的应用设置。	核心	GA
az staticwebapp appsettings delete	使用静态应用的给定密钥删除应用设置。	核心	GA
az staticwebapp appsettings list	列出静态应用的应用设置。	核心	GA
az staticwebapp appsettings set	添加或更改静态应用的应用设置。	核心	GA
az staticwebapp backends	使用静态 Web 应用链接或取消链接预先启动后端。 也称为“自带 API”。	核心	GA
az staticwebapp backends link	将后端链接到静态 Web 应用。 也称为“自带 API”。	核心	GA
az staticwebapp backends show	显示链接到静态 Web 应用的后端的详细信息。	核心	GA
az staticwebapp backends unlink	从静态 Web 应用取消链接后端。	核心	GA
az staticwebapp backends validate	验证静态 Web 应用的后端。	核心	GA
az staticwebapp create	创建静态应用。 若要向静态 Web 应用提供内容并与 Github 存储库集成，请提供 Github 存储库 URL（--source）和分支（--branch）。 如果存储库位于 Github 组织下，请确保 Azure CLI Github 应用有权访问组织。 使用“--login-with-github”参数时，可以在浏览器中请求访问。 必须由组织的管理员授予访问权限。	核心	GA
az staticwebapp dbconnection	管理静态 Web 应用数据库连接。	分机	预览
az staticwebapp dbconnection create	创建静态 Web 应用数据库连接。	扩展	预览
az staticwebapp dbconnection delete	删除静态 Web 应用数据库连接。	分机	预览
az staticwebapp dbconnection show	获取静态 Web 应用数据库连接的详细信息。	分机	预览版
az staticwebapp delete	删除静态应用。	核心	GA
az staticwebapp disconnect	断开源代码管理的连接，以启用连接到其他存储库。	核心	GA
az staticwebapp enterprise-edge	管理适用于静态 Web 应用的 Azure Front Door CDN。 为获得最佳体验和可用性，请检查我们的文档https://aka.ms/swaedge。	核心	GA
az staticwebapp enterprise-edge disable	为静态 Web 应用禁用 Azure Front Door CDN。 为获得最佳体验和可用性，请检查我们的文档https://aka.ms/swaedge。	核心	GA
az staticwebapp enterprise-edge enable	为静态 Web 应用启用 Azure Front Door CDN。 启用企业级边缘需要重新注册 Azure Front Door Microsoft.CDN 资源提供程序。 为获得最佳体验和可用性，请检查我们的文档https://aka.ms/swaedge。	核心	GA
az staticwebapp enterprise-edge show	显示 Web 应用的 Azure Front Door CDN 的状态（已启用、禁用、启用、禁用）。 为获得最佳体验和可用性，请检查我们的文档https://aka.ms/swaedge。	核心	GA
az staticwebapp environment	管理静态应用的环境。	核心	GA
az staticwebapp environment delete	删除静态应用生产环境或指定环境。	核心	GA
az staticwebapp environment functions	显示有关函数的信息。	核心	GA
az staticwebapp environment list	列出静态应用的所有环境，包括生产环境。	核心	GA
az staticwebapp environment show	显示有关生产环境或指定环境的信息。	核心	GA
az staticwebapp functions	使用静态 Web 应用链接或取消链接预Xisting functionapp。 也称为“自带函数”。	核心	GA
az staticwebapp functions link	将 Azure 函数链接到静态 Web 应用。 也称为“自带函数”。单个静态 Web 应用只能使用一个 Azure Functions 应用。 静态 Web 应用 SKU 必须是“标准”。	核心	GA
az staticwebapp functions show	显示链接到静态 Web 应用的 Azure 函数的详细信息。	核心	GA
az staticwebapp functions unlink	从静态 Web 应用取消链接 Azure 函数。	核心	GA
az staticwebapp hostname	管理静态应用的 Functions 的自定义主机名。	核心	GA
az staticwebapp hostname delete	删除静态应用的给定主机名。	核心	GA
az staticwebapp hostname list	列出静态应用的自定义主机名。	核心	GA
az staticwebapp hostname set	将给定的子域主机名设置为静态应用。 请使用 DNS 提供程序配置 CNAME/TXT/ALIAS 记录。 使用 --no-wait 不等待验证。	核心	GA
az staticwebapp hostname show	获取 staticwebapp 自定义域的详细信息。 可用于提取 TXT 域验证的验证令牌（请参阅示例）。	核心	GA
az staticwebapp identity	管理静态 Web 应用的托管标识。	核心	GA
az staticwebapp identity assign	将托管标识分配给静态 Web 应用。	核心	GA
az staticwebapp identity remove	禁用静态 Web 应用的托管标识。	核心	GA
az staticwebapp identity show	显示静态 Web 应用的托管标识。	核心	GA
az staticwebapp list	列出订阅中的所有静态应用资源，或者列出资源组（如果提供）。	核心	GA
az staticwebapp reconnect	在断开连接命令后连接存储库和分支。	核心	GA
az staticwebapp secrets	管理静态应用的部署令牌。	核心	GA
az staticwebapp secrets list	列出静态应用的部署令牌。	核心	GA
az staticwebapp secrets reset-api-key	重置静态应用的部署令牌。	核心	GA
az staticwebapp show	显示静态应用的详细信息。	核心	GA
az staticwebapp update	更新静态应用。 返回更新的应用。	核心	GA
az staticwebapp users	管理静态应用的用户。	核心	GA
az staticwebapp users invite	为指定的用户创建指向静态应用的邀请链接。	核心	GA
az staticwebapp users list	列出用户和分配的角色，仅限于接受邀请的用户。	核心	GA
az staticwebapp users update	汇报具有列出的角色的用户条目。 需要用户详细信息或用户 ID。	核心	GA

az staticwebapp create

创建静态应用。 若要向静态 Web 应用提供内容并与 Github 存储库集成，请提供 Github 存储库 URL（--source）和分支（--branch）。 如果存储库位于 Github 组织下，请确保 Azure CLI Github 应用有权访问组织。 使用“--login-with-github”参数时，可以在浏览器中请求访问。 必须由组织的管理员授予访问权限。

az staticwebapp create --name
                       --resource-group
                       [--api-location]
                       [--app-location]
                       [--branch]
                       [--location]
                       [--login-with-ado]
                       [--login-with-github]
                       [--no-wait]
                       [--output-location]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

示例

在订阅中创建静态应用。

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master -t MyAccessToken

在订阅中创建静态应用，以交互方式检索令牌

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master --login-with-github

创建不含任何内容的静态 Web 应用，无需 github 集成

az staticwebapp create -n MyStaticAppName -g MyExistingRg

必需参数

--name -n

静态站点的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--api-location

Azure Functions 代码的位置。 例如，“/api”表示名为“api”的文件夹。

--app-location

应用程序代码的位置。 例如，“/”表示应用的根目录，而“/app”表示名为“app”的目录。

默认值: /

--branch -b

存储库中的目标分支。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

默认值: centralus

--login-with-ado

使用 Azure 凭据创建 Azure Dev Ops 个人访问令牌。

默认值: False

--login-with-github

使用 Github 以交互方式登录以检索个人访问令牌。

默认值: False

--no-wait

不等待长时间运行的操作完成。

默认值: False

--output-location

生成输出相对于应用位置的路径。 例如，将应用位置设置为“/app”时设置“build”值将导致提供“/app/build”中的内容。

--sku

静态 Web 应用的定价层。

接受的值: Free, Standard

默认值: Free

--source -s

静态站点存储库的 URL。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--token -t

用户的 GitHub 或 Azure Dev Ops 存储库令牌。 这用于创建 Github Action 或 Dev Ops 管道。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp delete

删除静态应用。

az staticwebapp delete --name
                       [--no-wait]
                       [--resource-group]
                       [--yes]

示例

删除静态应用。

az staticwebapp delete -n MyStaticAppName -g MyRg

必需参数

--name -n

静态站点的名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp disconnect

断开源代码管理的连接，以启用连接到其他存储库。

az staticwebapp disconnect --name
                           [--no-wait]
                           [--resource-group]

示例

断开静态应用的连接。

az staticwebapp disconnect -n MyStaticAppName

必需参数

--name -n

静态站点的名称。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp list

列出订阅中的所有静态应用资源，或者列出资源组（如果提供）。

az staticwebapp list [--resource-group]

示例

列出订阅中的静态应用。

az staticwebapp list

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp reconnect

在断开连接命令后连接存储库和分支。

az staticwebapp reconnect --branch
                          --name
                          --source
                          [--login-with-github]
                          [--no-wait]
                          [--resource-group]
                          [--token]

示例

连接存储库和分支到静态应用。

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --token MyAccessToken

连接存储库和分支到静态应用，以交互方式检索令牌

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --login-with-github

必需参数

--branch -b

存储库中的目标分支。

--name -n

静态站点的名称。

--source -s

静态站点存储库的 URL。

可选参数

--login-with-github

使用 Github 以交互方式登录以检索个人访问令牌。

默认值: False

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--token -t

用户的 GitHub 或 Azure Dev Ops 存储库令牌。 这用于创建 Github Action 或 Dev Ops 管道。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp show

显示静态应用的详细信息。

az staticwebapp show --name
                     [--resource-group]

示例

在订阅中显示静态应用。

az staticwebapp show -n MyStaticAppName

必需参数

--name -n

静态站点的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az staticwebapp update

更新静态应用。 返回更新的应用。

az staticwebapp update --name
                       [--branch]
                       [--no-wait]
                       [--resource-group]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

示例

将静态应用更新为标准 SKU。

az staticwebapp update -n MyStaticAppName --sku Standard

必需参数

--name -n

静态站点的名称。

可选参数

--branch -b

存储库中的目标分支。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--sku

静态 Web 应用的定价层。

接受的值: Free, Standard

--source -s

静态站点存储库的 URL。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--token -t

用户的 GitHub 或 Azure Dev Ops 存储库令牌。 这用于创建 Github Action 或 Dev Ops 管道。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。