你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az network application-gateway
管理应用程序级别的路由和负载平衡服务。
若要了解有关应用程序网关的详细信息,请访问https://learn.microsoft.com/en-us/azure/application-gateway/quick-create-cli。
命令
az network application-gateway create
创建应用程序网关。
az network application-gateway create --name
--resource-group
[--capacity]
[--cert-file]
[--cert-password]
[--connection-draining-timeout]
[--custom-error-pages]
[--enable-private-link]
[--frontend-port]
[--http-settings-cookie-based-affinity {Disabled, Enabled}]
[--http-settings-port]
[--http-settings-protocol {Http, Https, Tcp, Tls}]
[--http2 {Disabled, Enabled}]
[--identity]
[--key-vault-secret-id]
[--location]
[--max-capacity]
[--min-capacity]
[--no-wait]
[--priority]
[--private-ip-address]
[--private-link-ip-address]
[--private-link-primary {false, true}]
[--private-link-subnet]
[--private-link-subnet-prefix]
[--public-ip-address]
[--public-ip-address-allocation]
[--routing-rule-type {Basic, PathBasedRouting}]
[--servers]
[--sku {Standard_Medium, Standard_Small, Standard_v2, WAF_Large, WAF_Medium, WAF_v2}]
[--ssl-certificate-name]
[--ssl-profile]
[--ssl-profile-id]
[--subnet]
[--subnet-address-prefix]
[--tags]
[--trusted-client-cert]
[--validate]
[--vnet-address-prefix]
[--vnet-name]
[--waf-policy]
[--zones]
示例
创建应用程序网关。
az network application-gateway create --capacity 2 --frontend-port MyFrontendPort --http-settings-cookie-based-affinity Enabled --http-settings-port 80 --http-settings-protocol Http --location westus2 --name MyAppGateway --public-ip-address MyAppGatewayPublicIp --resource-group MyResourceGroup --sku Standard_Small --subnet MySubnet --vnet-name MyVNet
使用 VM 作为后端服务器创建应用程序网关。
az network application-gateway create -g MyResourceGroup -n MyAppGateway --capacity 2 --sku Standard_Medium --vnet-name MyVNet --subnet MySubnet --http-settings-cookie-based-affinity Enabled --public-ip-address MyAppGatewayPublicIp --servers 10.0.0.4 10.0.0.5
使用 SSL 配置文件创建应用程序网关。
az network application-gateway create -n MyAppGateway -g MyResourceGroup --public-ip-address MyPublicIP --sku Standard_v2 --priority 1001 --ssl-profile name=MyProfile min-protocol-version=TLSv1_0 cipher-suites=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 policy-type=Custom client-auth-configuration=True
必需参数
应用程序网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
要与应用程序网关一起使用的实例数。
PFX 证书文件的路径。
证书密码。
删除后端服务器后的时间(以秒为单位),在此期间打开的连接保持活动状态。 范围:0(已禁用)到 3600。
格式的自定义错误页 STATUS_CODE=URL
的空格分隔列表。
为此应用程序网关启用专用链接功能。 如果同时对公共 IP 和专用 IP 进行均衡,则仅在公共前端 IP 中生效。
前端端口号。
启用或禁用基于 COOKIE 的 HTTP 设置相关性。
HTTP 设置端口。
HTTP 设置协议。
将 HTTP2 用于应用程序网关。
ManagedIdentity 资源的名称或 ID。
存储在 Azure KeyVault 中的“secret”或“Certificate”对象的机密 ID(base-64 编码的未加密 pfx)。 需要为 keyvault 启用软删除才能使用此功能。
位置。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
应用程序网关实例数上限。
应用程序网关实例数的下限。
不等待长时间运行的操作完成。
请求路由规则的优先级。 支持的 SKU 层Standard_v2,WAF_v2。
要使用的静态专用 IP 地址。
专用链接子网的静态专用 IP 地址。 如果省略,将创建一个动态的。
IP 配置是否为主。
应用程序网关的同一 vnet 中子网的名称。
创建新子网时要使用的 CIDR 前缀。
公共 IP 地址的名称或 ID。 使用现有资源或创建新的资源(如果指定)或省略任何资源。
创建新公共 IP 时要使用的 IP 分配类型。
请求路由规则类型。
与后端服务器对应的 IP 地址或 DNS 名称的空间分隔列表。
SKU 的名称。
证书名称。 默认值为 <application-gateway-name>SslCert
.
应用程序网关 ssl 配置文件。
用法:--ssl-profile name=MySslProfile client-auth-configuration=True cipher-suites=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 policy-type=Custom min-protocol-version=TLSv1_0
名称:必需。 在应用程序网关中唯一的 SSL 配置文件的名称。 警务名称:Ssl 策略的名称。 策略类型:Ssl 策略的类型。 min-protocol-version:应用程序网关支持的最低 Ssl 协议版本。 密码套件:为应用程序网关指定顺序启用的 Ssl 密码套件。 disabled-ssl-protocols:要禁用的协议的空间分隔列表。 trusted-client-certificates:对应用程序网关受信任客户端证书的引用数组。 client-auth-configuration:应用程序网关资源的客户端身份验证配置。
可以使用多个 --ssl-profile
参数来指定多个 ssl 配置文件。
应用程序网关的 SSL 配置文件资源。
子网的名称或 ID。 如果资源不存在,将创建资源。 如果指定了名称,则还指定 --vnet-name。 如果要在其他资源组或订阅中使用现有子网,请提供 ID 而不是子网的名称。
创建新子网时要使用的 CIDR 前缀。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
应用程序网关受信任的客户端证书。
用法:--trusted-client-certificates name=client1 data=client.cer
名称:必需。 在应用程序网关数据中唯一的受信任客户端证书的名称:必需。 证书公共数据。
可以使用多个 --trusted-client-certificates
参数来指定多个受信任的客户端证书。
生成并验证 ARM 模板,而无需创建任何资源。
创建新 VNet 时要使用的 CIDR 前缀。
虚拟网络(VNet)名称。
Web 应用程序防火墙(WAF)策略的名称或 ID。
要在其中预配资源的可用性区域的空间分隔列表。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway delete
删除应用程序网关。
az network application-gateway delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
示例
删除应用程序网关。
az network application-gateway delete -g MyResourceGroup -n MyAppGateway
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
应用程序网关的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway list
列出应用程序网关。
az network application-gateway list [--max-items]
[--next-token]
[--resource-group]
示例
列出应用程序网关。
az network application-gateway list -g MyResourceGroup
可选参数
命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的参数中 --next-token
提供令牌值。
用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway show
获取应用程序网关的详细信息。
az network application-gateway show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
获取应用程序网关的详细信息。
az network application-gateway show -g MyResourceGroup -n MyAppGateway
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
应用程序网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway show-backend-health
获取有关应用程序网关的后端运行状况的信息。
az network application-gateway show-backend-health [--address-pool]
[--expand]
[--host]
[--host-name-from-http-settings {false, true}]
[--http-settings]
[--ids]
[--match-body]
[--match-status-codes]
[--name]
[--path]
[--protocol {Http, Https, Tcp, Tls}]
[--resource-group]
[--subscription]
[--timeout]
示例
显示应用程序网关的后端运行状况。
az network application-gateway show-backend-health -g MyResourceGroup -n MyAppGateway
显示应用程序网关的后端运行状况,以便给定后端池和 http 设置的组合。
az network application-gateway show-backend-health -g MyResourceGroup -n MyAppGateway --host-name-from-http-settings --path /test --timeout 100 --http-settings appGatewayBackendHttpSettings --address-pool appGatewayBackendPool
可选参数
后端地址池的名称或 ID。
展开后端运行状况中引用的 BackendAddressPool 和 BackendHttp设置。
要发送探测的主机的名称。
使用 HTTP 设置中的主机标头。
HTTP 设置的名称或 ID。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
运行状况响应中必须包含的正文。
运行状况响应的允许状态代码范围的空格分隔列表。
应用程序网关的名称。
探测的相对路径。 有效路径从“/”开始。
HTTP 设置协议。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
探测超时(以秒为单位)。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway start
启动应用程序网关。
az network application-gateway start [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
示例
启动应用程序网关。
az network application-gateway start -g MyResourceGroup -n MyAppGateway
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
应用程序网关的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway stop
停止应用程序网关。
az network application-gateway stop [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
示例
停止应用程序网关。
az network application-gateway stop -g MyResourceGroup -n MyAppGateway
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
应用程序网关的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway update
更新应用程序网关。
az network application-gateway update [--add]
[--capacity]
[--custom-error-pages]
[--family {Generation_1, Generation_2}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--http2 {Disabled, Enabled}]
[--identity]
[--ids]
[--max-capacity]
[--min-capacity]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--sku {Basic, Standard_Large, Standard_Medium, Standard_Small, Standard_v2, WAF_Large, WAF_Medium, WAF_v2}]
[--ssl-profiles]
[--subscription]
[--tags]
示例
更新应用程序网关。
az network application-gateway update --name MyApplicationGateway --resource-group MyResourceGroup --set sku.tier=WAF_v2
通过 OCSP 启用客户端证书吊销。
az network application-gateway update -n MyApplicationGateway --ssl-profiles [0].client-auth-configuration.verify-client-revocation=OCSP
可选参数
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。
要与应用程序网关一起使用的实例数。
格式的自定义错误页 STATUS_CODE=URL
的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
应用程序网关 SKU 系列。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
将 HTTP2 用于应用程序网关。
应用程序网关的标识(如果已配置)。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
应用程序网关实例数上限。
应用程序网关实例数的下限。
应用程序网关的名称。
不等待长时间运行的操作完成。
从列表中删除属性或元素。 示例:--remove property.list OR --remove propertyToRemove。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=。
应用程序网关 SKU 的名称。
应用程序网关资源的 SSL 配置文件。 有关默认限制,请参阅应用程序网关限制。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
空格分隔标记:key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az network application-gateway wait
将 CLI 置于等待状态,直到满足条件。
az network application-gateway wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
轮询间隔(以秒为单位)。
应用程序网关的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。