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

az networkcloud kubernetescluster

注意

此参考是 Azure CLI(版本 2.51.0 或更高版本)的网络云扩展的一部分。 该扩展将在首次运行 az networkcloud kubernetescluster 命令时自动安装。 详细了解扩展。

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

管理 Kubernetes 群集。

命令

名称 说明 类型 状态
az networkcloud kubernetescluster agentpool

管理 Kubernetes 群集的代理池。

分机 预览
az networkcloud kubernetescluster agentpool create

创建新的 Kubernetes 群集代理池或更新现有池的属性。

分机 预览
az networkcloud kubernetescluster agentpool delete

删除提供的 Kubernetes 群集代理池。

分机 预览
az networkcloud kubernetescluster agentpool list

列出提供的 Kubernetes 群集的代理池。

分机 预览
az networkcloud kubernetescluster agentpool show

获取提供的 Kubernetes 群集代理池的属性。

分机 预览版
az networkcloud kubernetescluster agentpool update

更新提供的 Kubernetes 群集代理池的属性,或更新与 Kubernetes 群集代理池关联的标记。 属性和标记更新可以独立完成。

分机 预览
az networkcloud kubernetescluster agentpool wait

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

分机 预览版
az networkcloud kubernetescluster create

创建新的 Kubernetes 群集或更新现有群集的属性。

扩展 预览
az networkcloud kubernetescluster delete

删除提供的 Kubernetes 群集。

扩展 预览版
az networkcloud kubernetescluster list

列出提供的订阅中的 Kubernetes 群集。

分机 预览版
az networkcloud kubernetescluster restart-node

重启 Kubernetes 群集的目标节点。

分机 预览
az networkcloud kubernetescluster show

获取提供的 Kubernetes 群集的属性。

扩展 预览
az networkcloud kubernetescluster update

更新提供的 Kubernetes 群集的属性,或更新与 Kubernetes 群集关联的标记。 属性和标记更新可以独立完成。

分机 预览版
az networkcloud kubernetescluster wait

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

扩展 预览

az networkcloud kubernetescluster create

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

创建新的 Kubernetes 群集或更新现有群集的属性。

az networkcloud kubernetescluster create --control-plane-node-configuration
                                         --extended-location
                                         --initial-agent-pool-configurations
                                         --kubernetes-cluster-name
                                         --kubernetes-version
                                         --network-configuration
                                         --resource-group
                                         [--aad-configuration]
                                         [--admin-username]
                                         [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--location]
                                         [--managed-resource-group-configuration]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ssh-dest-key-path]
                                         [--ssh-key-values]
                                         [--tags]

示例

创建或更新 Kubernetes 群集

az networkcloud kubernetescluster create --name "kubernetesClusterName" --resource-group "resourceGroupName" --location "location" --kubernetes-version "1.XX.Y" --extended-location name="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type=CustomLocation --aad-configuration admin-group-object-ids=["f110271b-XXXX-4163-9b99-214d91660f0e"] --admin-username "azureuser" --ssh-key-values "ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm" --initial-agent-pool-configurations "[{count:1,mode:'System',name:'systemPool-1',vmSkuName:'NC-XXXXX',agentOptions:{hugepagesCount:96,hugepagesSize:1G},upgradeSettings:{maxSurge:'10%'},adminUsername:'azureuser',ssh-key-values:['ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm']}]" --control-plane-node-configuration count=1 vmSkuName='NC-YYYYY' adminUsername='azureuser' ssh-key-values="['ssh-rsa AAAAB3NzaC1yc2EAAAADAQAt5SjWU= admin@vm']" --network-configuration cloud-services-network-id="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName" cni-network-id="/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" pod-cidrs=["10.244.0.0/16"] service-cidrs=["10.96.0.0/16"] dns-service-ip="10.96.0.10" attached-network-configuration.l2-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName',pluginType:'DPDK'}]" attached-network-configuration.l3-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName',pluginType:'SRIOV',ipamEnabled:'False'}]" attached-network-configuration.trunked-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName',pluginType:'MACVLAN'}]" bgp-service-load-balancer-configuration.bgp-advertisements="[{advertiseToFabric:'True',communities:['64512:100'],ipAddressPools:['pool1'],peers:['peer1']}]" bgp-service-load-balancer-configuration.fabric-peering-enabled="True" bgp-service-load-balancer-configuration.bgp-peers="[{bfdEnabled:'False',bgpMultiHop:'False',holdTime:'P300s',keepAliveTime:'P300s',myAsn:64512,name:'peer1',peerAddress:'203.0.113.254',peerAsn:64497,peerPort:179}]" bgp-service-load-balancer-configuration.ip-address-pools="[{addresses:['198.51.102.0/24'],autoAssign:'True',name:'pool1',onlyUseHostIps:'True'}]"

必需参数

--control-plane-node-configuration

此 Kubernetes 群集的控制平面的定义特征。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--extended-location

与资源关联的群集的扩展位置。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--initial-agent-pool-configurations

使用此 Kubernetes 群集创建的代理池,用于运行关键系统服务和工作负荷。 此字段中的此数据仅在创建过程中使用,在创建 Kubernetes 群集后,该字段将为空。 创建后,使用 agentPools 子资源完成代理池的管理。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

--kubernetes-version

此群集的 Kubernetes 版本。 接受 n.n、n.n.n 和 n.n.n-n 格式。 创建或更新后,所使用的解释版本将解析为此字段。

--network-configuration

Kubernetes 群集网络的配置,包括跨群集的网络的附件。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--resource-group -g

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

可选参数

--aad-configuration

Azure Active Directory 集成属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--admin-username

将应用于运行 Kubernetes 节点的操作系统的管理员的用户名。 如果未提供,服务将选择用户名。

--generate-ssh-keys

生成 SSH 公钥和私钥文件(如果缺少)。 密钥将存储在“~/.ssh”下。

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

未指定资源所在的地理位置,将使用资源组的位置。

--managed-resource-group-configuration

与资源关联的托管资源组的配置。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ssh-dest-key-path

ssh 公钥的空间分隔路径列表。 可以提供文件路径或目录。 如果提供了目录,将尝试加载找到的所有公钥(.pub)。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--ssh-key-values

空格分隔的 SSH 公钥列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--tags

资源标记。 支持速记语法、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 networkcloud kubernetescluster delete

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

删除提供的 Kubernetes 群集。

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

示例

删除 Kubernetes 群集

az networkcloud kubernetescluster delete --name "kubernetesClusterName" --resource-group "resourceGroupName"

可选参数

--ids

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

--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

--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 networkcloud kubernetescluster list

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

列出提供的订阅中的 Kubernetes 群集。

az networkcloud kubernetescluster list [--max-items]
                                       [--next-token]
                                       [--resource-group]

示例

列出订阅的 Kubernetes 群集

az networkcloud kubernetescluster list

列出资源组的 Kubernetes 群集

az networkcloud kubernetescluster list --resource-group "resourceGroupName"

可选参数

--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 networkcloud kubernetescluster restart-node

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

重启 Kubernetes 群集的目标节点。

az networkcloud kubernetescluster restart-node --node-name
                                               [--ids]
                                               [--kubernetes-cluster-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

示例

重启 Kubernetes 群集节点

az networkcloud kubernetescluster restart-node --node-name "nodeName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

必需参数

--node-name

要重启的节点的名称。

可选参数

--ids

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

--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

--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 配置默认订阅。

全局参数
--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 networkcloud kubernetescluster show

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

获取提供的 Kubernetes 群集的属性。

az networkcloud kubernetescluster show [--ids]
                                       [--kubernetes-cluster-name]
                                       [--resource-group]
                                       [--subscription]

示例

获取 Kubernetes 群集

az networkcloud kubernetescluster show --name "kubernetesClusterName" --resource-group "resourceGroupName"

可选参数

--ids

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

--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

--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 networkcloud kubernetescluster update

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

更新提供的 Kubernetes 群集的属性,或更新与 Kubernetes 群集关联的标记。 属性和标记更新可以独立完成。

az networkcloud kubernetescluster update [--control-plane-node-configuration]
                                         [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--kubernetes-cluster-name]
                                         [--kubernetes-version]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--ssh-dest-key-path]
                                         [--ssh-key-values]
                                         [--subscription]
                                         [--tags]

示例

修补 Kubernetes 群集

az networkcloud kubernetescluster update --name "kubernetesClusterName" --resource-group "resourceGroupName" --kubernetes-version "1.25.4" --control-plane-node-configuration count="3" --tags key1="myvalue1" key2="myvalue2"

更新 Kubernetes 群集管理员凭据

az networkcloud kubernetescluster update --name "kubernetesClusterName" --resource-group "resourceGroupName" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm'

更新 Kubernetes 群集控制节点管理员凭据

az networkcloud kubernetescluster update --name "kubernetesClusterName" --resource-group "resourceGroupName" --control-plane-node-configuration ssh-key-values="['ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm']"

可选参数

--control-plane-node-configuration

可为此 Kubernetes 群集修补的控制平面的定义特征。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--generate-ssh-keys

生成 SSH 公钥和私钥文件(如果缺少)。 密钥将存储在“~/.ssh”下。

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

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

--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

--kubernetes-version

此群集的 Kubernetes 版本。 接受 n.n、n.n.n 和 n.n.n-n 格式。 创建或更新后,所使用的解释版本将解析为此字段。

--no-wait

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

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

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

--ssh-dest-key-path

ssh 公钥的空间分隔路径列表。 可以提供文件路径或目录。 如果提供了目录,将尝试加载找到的所有公钥(.pub)。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--ssh-key-values

空格分隔的 SSH 公钥列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--subscription

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

--tags

将替换现有标记的 Azure 资源标记。 支持速记语法、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 networkcloud kubernetescluster wait

预览

命令组“az networkcloud”处于预览状态,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

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

az networkcloud kubernetescluster wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--kubernetes-cluster-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
--kubernetes-cluster-name --name -n

Kubernetes 群集的名称。

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