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

az network lb rule

管理负载均衡规则。

命令

名称 说明 类型 Status
az network lb rule create

创建负载均衡规则。

核心 GA
az network lb rule delete

删除负载均衡规则。

核心 GA
az network lb rule list

列出负载均衡规则。

核心 GA
az network lb rule show

获取负载均衡规则的详细信息。

核心 GA
az network lb rule update

更新负载均衡规则。

核心 GA
az network lb rule wait

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

核心 GA

az network lb rule create

创建负载均衡规则。

az network lb rule create --backend-port
                          --frontend-port
                          --lb-name
                          --name
                          --protocol {All, Tcp, Udp}
                          --resource-group
                          [--backend-pool-name]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]

示例

创建一个负载均衡规则,该规则将前端 IP 配置和端口分配给地址池和端口。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --frontend-port 80 --backend-pool-name MyAddressPool --backend-port 80

创建一个负载均衡规则,该规则使用浮动 IP 功能将前端 IP 配置和端口分配给地址池和端口。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --backend-pool-name MyAddressPool --floating-ip true --frontend-port 80 --backend-port 80

创建 HA 端口负载均衡规则,该规则分配前端 IP 和端口,以在同一端口上使用池中的所有可用后端 IP。

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyHAPortsRule --protocol All --frontend-port 0 --backend-port 0 --frontend-ip MyFrontendIp --backend-pool-name MyAddressPool

必需参数

--backend-port

用于终结点上内部连接的端口。 可接受的值为 0 到 65535。 请注意,值 0 启用“任何端口”。

--frontend-port

外部终结点的端口。 每个规则的端口号在负载均衡器内必须是唯一的。 可接受的值为 0 到 65534。 请注意,值 0 启用“任何端口”。

--lb-name

负载均衡器名称。

--name -n

负载均衡规则的名称。

--protocol

对负载均衡规则使用的传输协议的引用。

接受的值: All, Tcp, Udp
--resource-group -g

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

可选参数

--backend-pool-name --backend-pools-name

后端地址池的 ID 或名称列表。 网关 SKU 负载均衡器仅支持多个池。 如果只有一个存在,则省略用作默认值。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--disable-outbound-snat

为后端池中的 VM 配置 SNAT,以使用负载均衡规则前端中指定的 publicIP 地址。

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

为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。

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

在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。 仅当协议设置为 TCP 时,才使用此元素。

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

前端 IP 配置的 ID 的名称。

--idle-timeout --idle-timeout-in-minutes

TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅当协议设置为 TCP 时,才使用此元素。

--load-distribution

此规则的负载分发策略。

接受的值: Default, SourceIP, SourceIPProtocol
默认值: Default
--no-wait

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

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

要与此规则关联的现有探测的 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 network lb rule delete

删除负载均衡规则。

az network lb rule delete --lb-name
                          --name
                          --resource-group
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

删除负载均衡规则。

az network lb rule delete -g MyResourceGroup --lb-name MyLb -n MyLbRule

必需参数

--lb-name

负载均衡器名称。

--name -n

负载均衡规则的名称。

--resource-group -g

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

可选参数

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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 network lb rule list

列出负载均衡规则。

az network lb rule list --lb-name
                        --resource-group

示例

列出负载均衡规则。

az network lb rule list -g MyResourceGroup --lb-name MyLb -o table

必需参数

--lb-name

负载均衡器名称。

--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 network lb rule show

获取负载均衡规则的详细信息。

az network lb rule show --lb-name
                        --name
                        --resource-group

示例

获取负载均衡规则的详细信息。

az network lb rule show -g MyResourceGroup --lb-name MyLb -n MyLbRule

必需参数

--lb-name

负载均衡器名称。

--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 network lb rule update

更新负载均衡规则。

az network lb rule update --lb-name
                          --name
                          --resource-group
                          [--add]
                          [--backend-pool-name]
                          [--backend-port]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--frontend-port]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]
                          [--protocol {All, Tcp, Udp}]
                          [--remove]
                          [--set]

示例

更新负载均衡规则以将协议更改为 UDP。

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Udp

更新负载均衡规则以支持 HA 端口。

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol All --frontend-port 0 --backend-port 0

必需参数

--lb-name

负载均衡器名称。

--name -n

负载均衡规则的名称。

--resource-group -g

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

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--backend-pool-name --backend-pools-name

后端地址池的 ID 或名称列表。 网关 SKU 负载均衡器仅支持多个池。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--backend-port

用于终结点上内部连接的端口。 可接受的值为 0 到 65535。 请注意,值 0 启用“任何端口”。

--disable-outbound-snat

为后端池中的 VM 配置 SNAT,以使用负载均衡规则前端中指定的 publicIP 地址。

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

为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。

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

在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。 仅当协议设置为 TCP 时,才使用此元素。

接受的值: 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
--frontend-ip --frontend-ip-name

前端 IP 配置的 ID 的名称。

--frontend-port

外部终结点的端口。 每个规则的端口号在负载均衡器内必须是唯一的。 可接受的值为 0 到 65534。 请注意,值 0 启用“任何端口”。

--idle-timeout --idle-timeout-in-minutes

TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅当协议设置为 TCP 时,才使用此元素。

--load-distribution

此规则的负载分发策略。

接受的值: Default, SourceIP, SourceIPProtocol
--no-wait

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

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

要与此规则关联的现有探测的 ID 或名称。

--protocol

对负载均衡规则使用的传输协议的引用。

接受的值: All, Tcp, Udp
--remove

从列表中删除属性或元素。 示例:--remove property.list OR --remove propertyToRemove。

--set

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

全局参数
--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 network lb rule wait

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

az network lb rule wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--lb-name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

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

--interval

轮询间隔(以秒为单位)。

默认值: 30
--lb-name

负载均衡器名称。

--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 获取完整的调试日志。