通过

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

az k8s-runtime load-balancer

Note

此参考是 Azure CLI（版本 2.70.0 或更高版本）的 k8s 运行时 扩展的一部分。 该扩展会在首次运行 az k8s-runtime load-balancer 命令时自动安装。 了解更多关于扩展的信息。

管理 Arc Kubernetes 群集的负载均衡器。

命令

名称 说明 类型 Status
az k8s-runtime load-balancer create

创建 LoadBalancer。

 Extension GA
az k8s-runtime load-balancer delete

删除 LoadBalancer。

 Extension GA
az k8s-runtime load-balancer disable

在连接的群集中禁用load_balancer服务。

 Extension GA
az k8s-runtime load-balancer enable

在连接的群集中启用负载均衡器服务。

 Extension GA
az k8s-runtime load-balancer list

按父级列出 LoadBalancer 资源。

 Extension GA
az k8s-runtime load-balancer show

获取 LoadBalancer。

 Extension GA
az k8s-runtime load-balancer update

更新 LoadBalancer。

 Extension GA
az k8s-runtime load-balancer wait

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

 Extension GA

az k8s-runtime load-balancer create

创建 LoadBalancer。

az k8s-runtime load-balancer create --load-balancer-name
                                    --resource-uri
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--service-selector]

示例

创建负载均衡器

az k8s-runtime load-balancer create --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --addresses "192.168.50.1/32" --advertise-mode ARP --service-selector ""

必需参数

--load-balancer-name

LoadBalancer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--addresses

IP 范围支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--advertise-mode

播发模式。

属性 值
参数组: Properties Arguments
接受的值: ARP, BGP, Both
--bgp-peers

它应播发到的 BGP 对等方的列表。 Null 或空表示向所有对等方播发。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--communities

BGP 社区支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--service-selector

用于选择相关服务的动态标签映射。 例如，如果只想为标签为“a=b”的服务创建负载均衡器，请在字段中指定 {“a”： “b”} 。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer delete

删除 LoadBalancer。

az k8s-runtime load-balancer delete --load-balancer-name
                                    --resource-uri
                                    [--yes]

示例

删除负载均衡器

az k8s-runtime load-balancer delete --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必需参数

--load-balancer-name

LoadBalancer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer disable

在连接的群集中禁用load_balancer服务。

az k8s-runtime load-balancer disable --resource-uri

必需参数

--resource-uri

连接的群集的资源 URI。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer enable

在连接的群集中启用负载均衡器服务。

az k8s-runtime load-balancer enable --resource-uri

必需参数

--resource-uri

连接的群集的资源 URI。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer list

按父级列出 LoadBalancer 资源。

az k8s-runtime load-balancer list --resource-uri
                                  [--max-items]
                                  [--next-token]

示例

列出群集中的所有负载均衡器

az k8s-runtime load-balancer list --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必需参数

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--max-items

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

属性 值
参数组: Pagination Arguments
--next-token

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

属性 值
参数组: Pagination Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer show

获取 LoadBalancer。

az k8s-runtime load-balancer show --load-balancer-name
                                  --resource-uri

示例

获取负载均衡器

az k8s-runtime load-balancer show --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

必需参数

--load-balancer-name

LoadBalancer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer update

更新 LoadBalancer。

az k8s-runtime load-balancer update --load-balancer-name
                                    --resource-uri
                                    [--add]
                                    [--addresses]
                                    [--advertise-mode {ARP, BGP, Both}]
                                    [--bgp-peers]
                                    [--communities]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--remove]
                                    [--service-selector]
                                    [--set]

示例

更新负载均衡器

az k8s-runtime load-balancer update --load-balancer-name testlb1 --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --advertise-mode ARP

必需参数

--load-balancer-name

LoadBalancer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--add

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

属性 值
参数组: Generic Update Arguments
--addresses

IP 范围支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--advertise-mode

播发模式。

属性 值
参数组: Properties Arguments
接受的值: ARP, BGP, Both
--bgp-peers

它应播发到的 BGP 对等方的列表。 Null 或空表示向所有对等方播发。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--communities

BGP 社区支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--force-string

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

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

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

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

属性 值
参数组: Generic Update Arguments
--service-selector

用于选择相关服务的动态标签映射。 例如，如果只想为标签为“a=b”的服务创建负载均衡器，请在字段中指定 {“a”： “b”} 。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
参数组: Properties Arguments
--set

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

属性 值
参数组: Generic Update Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az k8s-runtime load-balancer wait

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

az k8s-runtime load-balancer wait --load-balancer-name
                                  --resource-uri
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--interval]
                                  [--timeout]
                                  [--updated]

必需参数

--load-balancer-name

LoadBalancer 的名称。

--resource-uri

资源的完全限定的 Azure 资源管理器标识符。

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--created

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

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

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

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--interval

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

属性 值
参数组: Wait Condition Arguments
默认值: 30
--timeout

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

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False