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

az nginx deployment

参考

注意

此参考是 Azure CLI 的 nginx 扩展（版本 2.68.0 或更高版本）的一部分。该扩展将在首次运行 az nginx deployment 命令时自动安装。详细了解扩展。

管理 NGINX 部署资源。

命令

名称	说明	类型	Status
az nginx deployment api-key	管理 Nginxaas 部署 API 密钥。	外延	加语
az nginx deployment api-key create	为 Nginx 部署创建 API 密钥，以便访问数据平面 API 终结点。	外延	加语
az nginx deployment api-key delete	删除 Nginx 部署的 API 密钥。	外延	加语
az nginx deployment api-key list	列出给定 Nginx 部署的所有 API 密钥。	外延	加语
az nginx deployment api-key show	获取给定 Nginx 部署的指定 API 密钥。	外延	加语
az nginx deployment api-key update	更新 Nginx 部署的 API 密钥，以便访问数据平面 API 终结点。	外延	加语
az nginx deployment certificate	管理 NGINX 证书资源。	外延	加语
az nginx deployment certificate create	为 NGINX 部署创建证书。	外延	加语
az nginx deployment certificate delete	删除 NGINX 部署证书。	外延	加语
az nginx deployment certificate list	列出指定部署和资源组下的所有证书。	外延	加语
az nginx deployment certificate show	获取特定 NGINX 证书的属性。	外延	加语
az nginx deployment certificate update	更新 NGINX 部署证书。	外延	加语
az nginx deployment certificate wait	将 CLI 置于等待状态，直到满足条件。	外延	加语
az nginx deployment configuration	管理 NGINX 配置资源。	外延	加语
az nginx deployment configuration analyze	分析 NGINX 配置，而不将其应用到 NGINXaaS 部署。	外延	加语
az nginx deployment configuration create	为 NGINX 部署创建配置。	外延	加语
az nginx deployment configuration delete	删除 Nginx 配置。	外延	加语
az nginx deployment configuration list	列出指定部署和资源组下的所有配置。	外延	加语
az nginx deployment configuration show	获取特定 NGINX 配置的属性。	外延	加语
az nginx deployment configuration update	更新 NGINX 配置。	外延	加语
az nginx deployment configuration wait	将 CLI 置于等待状态，直到满足条件。	外延	加语
az nginx deployment create	为 Azure 资源创建 NGINX。	外延	加语
az nginx deployment delete	删除 NGINX 部署。	外延	加语
az nginx deployment list	NGINX 部署的列表。	外延	加语
az nginx deployment show	获取特定 NGINX 部署的属性。	外延	加语
az nginx deployment update	更新 NGINX 部署。	外延	加语
az nginx deployment wait	将 CLI 置于等待状态，直到满足条件。	外延	加语

az nginx deployment create

为 Azure 资源创建 NGINX。

az nginx deployment create --deployment-name
                           --resource-group
                           [--auto-upgrade-profile]
                           [--enable-diagnostics {0, 1, f, false, n, no, t, true, y, yes}]
                           [--identity]
                           [--location]
                           [--logging]
                           [--network-profile]
                           [--nginx-app-protect]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--scaling-properties]
                           [--sku]
                           [--tags]
                           [--user-profile]

示例

使用 PublicIP 创建部署

az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standard_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{public-ip-addresses:[{id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"

使用 PrivateIP 创建部署

az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standard_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{private-ip-addresses:[{private-ip-allocation-method:Static,subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet,private-ip-address:10.0.0.2}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"
az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standard_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{private-ip-addresses:[{private-ip-allocation-method:Dynamic,subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet,private-ip-address:10.0.0.2}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"

使用托管标识、存储帐户和缩放进行部署

az anginx deployment  create --deployment-name myDeployment --myResourceGroup azclitest-geo --location eastus --sku name=standard_Monthly_gmz7xq9ge3py --network-profile network-interface-configuration='{subnet-id:/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-azclitest/subnets/mySubnet}' front-end-ip-configuration='{public-ip-addresses:[{id:/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}' --identity '{"type":"UserAssigned","userAssignedIdentities":{"/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity":{}}}' --logging storage-account='{"account-name":"myStorageAccount","container-name":"myContainer"}' --scaling-properties capacity=10

使用托管标识、存储帐户和系统分配的托管标识进行部署

az az anginx deployment create --deployment-name myDeployment --myResourceGroup azclitest-geo --location eastus --sku name=standard_Monthly_gmz7xq9ge3py --network-profile network-interface-configuration='{subnet-id:/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-azclitest/subnets/mySubnet}' front-end-ip-configuration='{public-ip-addresses:[{id:/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}' --identity '{"type":"SystemAssigned"}' --logging storage-account='{"account-name":"myStorageAccount","container-name":"myContainer"}' --scaling-properties capacity=10

必需参数

--deployment-name --name -n

目标 NGINX 部署的名称。

--resource-group -g

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

可选参数

--auto-upgrade-profile

部署的自动升级设置。可以是稳定或预览支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--enable-diagnostics

用于启用/禁用诊断支持的布尔值。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--identity

托管标识，用于对 Azure 密钥保管库或存储帐户执行操作，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--location -l

位置。值来自：az account list-locations。可以使用 az configure --defaults location=<location>配置默认位置。

--logging

将日志发送到存储帐户。必须在 Azure 存储帐户上指定具有 Blob 参与者角色的托管标识，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--network-profile

IP 地址和 VNet + 子网信息支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--nginx-app-protect

NGINX 应用保护（NAP）的设置支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--scaling-properties

NGINX 容量单位（NCU）的缩放支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--sku

资源支持速记语法、json-file 和 yaml-file 的计费信息。请尝试“？？” 以显示更多内容。

--tags

用于部署的标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--user-profile

可选：首选通信电子邮件支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--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 nginx deployment delete

删除 NGINX 部署。

az nginx deployment delete [--deployment-name]
                           [--ids]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--resource-group]
                           [--subscription]
                           [--yes]

示例

部署删除

az nginx deployment delete --name myDeployment --resource-group myResourceGroup

可选参数

--deployment-name --name -n

目标 NGINX 部署的名称。

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--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 nginx deployment list

NGINX 部署的列表。

列出指定订阅下的所有部署。列出指定资源组下的所有 Nginx 部署。

az nginx deployment list [--max-items]
                         [--next-token]
                         [--resource-group]

示例

部署列表

az nginx deployment list
az nginx deployment list --resource-group myResourceGroup

可选参数

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--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 nginx deployment show

获取特定 NGINX 部署的属性。

az nginx deployment show [--deployment-name]
                         [--ids]
                         [--resource-group]
                         [--subscription]

示例

部署获取

az nginx deployment show --name myDeployment --resource-group myResourceGroup

可选参数

--deployment-name --name -n

目标 Nginx 部署的名称。

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--resource-group -g

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

--subscription

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

全局参数

--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 nginx deployment update

更新 NGINX 部署。

az nginx deployment update [--add]
                           [--auto-upgrade-profile]
                           [--deployment-name]
                           [--enable-diagnostics {0, 1, f, false, n, no, t, true, y, yes}]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--identity]
                           [--ids]
                           [--logging]
                           [--network-profile]
                           [--nginx-app-protect]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--remove]
                           [--resource-group]
                           [--scaling-properties]
                           [--set]
                           [--sku]
                           [--subscription]
                           [--tags]
                           [--user-profile]

示例

更新标记并启用对部署的诊断支持

az nginx deployment update --name myDeployment --resource-group myResourceGroup --location eastus2 --tags tag1="value1" tag2="value2" --enable-diagnostics

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

--auto-upgrade-profile

部署的自动升级设置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--deployment-name --name -n

目标 Nginx 部署的名称。

--enable-diagnostics

用于启用/禁用诊断支持的布尔值。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--identity

托管标识，用于对 Azure 密钥保管库或存储帐户执行操作，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--logging

--network-profile

IP 地址和 VNet + 子网信息支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--nginx-app-protect

NGINX 应用保护（NAP）的设置支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--remove

从列表中删除属性或元素。示例：--remove property.list <indexToRemove> 或 --remove propertyToRemove。

--resource-group -g

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

--scaling-properties

NGINX 容量单位（NCU）的缩放支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

--sku

资源支持速记语法、json-file 和 yaml-file 的计费信息。请尝试“？？” 以显示更多内容。

--subscription

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

--tags

用于部署的标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--user-profile

可选：首选通信电子邮件支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--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 nginx deployment wait

将 CLI 置于等待状态，直到满足条件。

az nginx deployment wait [--created]
                         [--custom]
                         [--deleted]
                         [--deployment-name]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--resource-group]
                         [--subscription]
                         [--timeout]
                         [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--deployment-name --name -n

目标 Nginx 部署的名称。

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 nginx deployment

命令

az nginx deployment create

示例

必需参数

可选参数

az nginx deployment delete

示例

可选参数

az nginx deployment list

示例

可选参数

az nginx deployment show

示例

可选参数

az nginx deployment update

示例

可选参数

az nginx deployment wait

可选参数

其他资源