通过

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

az networkcloud kubernetescluster agentpool

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.67.0 or higher). 该扩展将在首次运行 az networkcloud kubernetescluster agentpool 命令时自动安装。 Learn more about extensions.

管理 Kubernetes 群集的代理池。

命令

名称 说明 类型 Status
az networkcloud kubernetescluster agentpool create

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

 Extension GA
az networkcloud kubernetescluster agentpool delete

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

 Extension GA
az networkcloud kubernetescluster agentpool list

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

 Extension GA
az networkcloud kubernetescluster agentpool show

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

 Extension GA
az networkcloud kubernetescluster agentpool update

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

 Extension GA
az networkcloud kubernetescluster agentpool wait

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

 Extension GA

az networkcloud kubernetescluster agentpool create

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

az networkcloud kubernetescluster agentpool create --agent-pool-name --name
                                                   --count
                                                   --kc-name --kubernetes-cluster-name
                                                   --mode {NotApplicable, System, User}
                                                   --resource-group
                                                   --vm-sku-name
                                                   [--admin-username]
                                                   [--agent-options]
                                                   [--attached-network-configuration]
                                                   [--availability-zones]
                                                   [--extended-location]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--if-match]
                                                   [--if-none-match]
                                                   [--labels]
                                                   [--location]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--tags]
                                                   [--taints]
                                                   [--upgrade-settings]

示例

创建或更新 Kubernetes 群集的代理池

az networkcloud kubernetescluster agentpool create --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --admin-username "azureuser" --ssh-key-values 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgt5SjWU= admin@vm' --count 3 --mode "System" --vm-sku-name "NC-XXXXX" --agent-options hugepages-count=96 hugepages-size="1G" --attached-network-configuration l2-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName',pluginType:'DPDK'}]" l3-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName,pluginType:'SRIOV',ipamEnabled:'False'}]" trunked-networks="[{networkId:'/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName',pluginType:'MACVLAN'}]" --labels="[{key:'kubernetes.label',value:'true'}]" --taints="[{key:'kubernetes.taint',value:'true'}]" --upgrade-settings max-surge="1" --availability-zones="['zone1','zone2']"

必需参数

--agent-pool-name --name -n

Kubernetes 群集代理池的名称。

--count

使用此配置的虚拟机数。

属性 值
Parameter group: Properties Arguments
--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

--mode

选择此代理池作为系统池或用户池的方式。 系统池运行 Kubernetes 群集的功能和关键服务，而用户池则专用于用户工作负荷。 每个 Kubernetes 群集必须至少包含一个具有至少一个节点的系统节点池。

属性 值
Parameter group: Properties Arguments
接受的值: NotApplicable, System, User
--resource-group -g

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

--vm-sku-name

确定为节点 VM 分配的资源大小的 VM SKU 的名称。

属性 值
Parameter group: Properties Arguments

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--admin-username

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

属性 值
Parameter group: AdministratorConfiguration Arguments
--agent-options

将应用于此代理池中每个代理的配置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--attached-network-configuration

要附加到代理池的网络配置，供在此 Kubernetes 群集上运行的工作负荷使用。 这些网络是 Kubernetes 群集附加网络配置中连接的网络。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--availability-zones

用于在此代理池中预配节点的网络云群集的可用性区域列表。 如果未指定，将使用所有可用性区域。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--extended-location

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

属性 值
Parameter group: AgentPoolParameters Arguments
--generate-ssh-keys

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

属性 值
Parameter group: AdministratorConfiguration Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--labels

应用于此代理池中的节点的标签。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--location -l

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

属性 值
Parameter group: AgentPoolParameters Arguments
--no-wait

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

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

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

属性 值
Parameter group: AdministratorConfiguration Arguments
--ssh-key-values

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

属性 值
Parameter group: AdministratorConfiguration Arguments
--tags

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

属性 值
Parameter group: AgentPoolParameters Arguments
--taints

应用于此代理池中的节点的污点。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: Properties Arguments
--upgrade-settings

代理池的配置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

属性 值
默认值: 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 networkcloud kubernetescluster agentpool delete

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

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

示例

删除 Kubernetes 群集的代理池

az networkcloud kubernetescluster agentpool delete --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--agent-pool-name --name -n

Kubernetes 群集代理池的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

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

属性 值
Parameter group: Resource Id Arguments
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--yes -y

不要提示确认。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az networkcloud kubernetescluster agentpool list

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

az networkcloud kubernetescluster agentpool list --kc-name --kubernetes-cluster-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

示例

列出 Kubernetes 群集的代理池

az networkcloud kubernetescluster agentpool list --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

必需参数

--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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

属性 值
Parameter group: Pagination Arguments
--next-token

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

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

属性 值
默认值: 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 networkcloud kubernetescluster agentpool show

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

az networkcloud kubernetescluster agentpool show [--agent-pool-name --name]
                                                 [--ids]
                                                 [--kc-name --kubernetes-cluster-name]
                                                 [--resource-group]
                                                 [--subscription]

示例

获取 Kubernetes 群集的代理池

az networkcloud kubernetescluster agentpool show --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName"

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--agent-pool-name --name -n

Kubernetes 群集代理池的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

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

属性 值
Parameter group: Resource Id Arguments
--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
全局参数
--debug

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az networkcloud kubernetescluster agentpool update

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

az networkcloud kubernetescluster agentpool update [--agent-pool-name --name]
                                                   [--count]
                                                   [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--ids]
                                                   [--if-match]
                                                   [--if-none-match]
                                                   [--kc-name --kubernetes-cluster-name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--ssh-dest-key-path]
                                                   [--ssh-key-values]
                                                   [--subscription]
                                                   [--tags]
                                                   [--upgrade-settings]

示例

Kubernetes 群集的修补代理池

az networkcloud kubernetescluster agentpool update --name "poolName" --kubernetes-cluster-name "kubernetesClusterName" --resource-group "resourceGroupName" --count 3 --upgrade-settings max-surge="1"

更新代理池管理员凭据

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--agent-pool-name --name -n

Kubernetes 群集代理池的名称。

属性 值
Parameter group: Resource Id Arguments
--count

使用此配置的虚拟机数。

属性 值
Parameter group: Properties Arguments
--generate-ssh-keys

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

属性 值
Parameter group: AdministratorConfiguration Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

属性 值
Parameter group: Resource Id Arguments
--if-match

转换的 ETag。 省略此值以始终覆盖当前资源。 指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。

--if-none-match

设置为“*”以允许创建新记录集，但要防止更新现有资源。 其他值将导致服务器出错，因为它们不受支持。

--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Resource Id Arguments
--ssh-dest-key-path

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

属性 值
Parameter group: AdministratorConfiguration Arguments
--ssh-key-values

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

属性 值
Parameter group: AdministratorConfiguration Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--tags

将替换现有标记的 Azure 资源标记。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性 值
Parameter group: AgentPoolUpdateParameters Arguments
--upgrade-settings

代理池的配置。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False

az networkcloud kubernetescluster agentpool wait

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

az networkcloud kubernetescluster agentpool wait [--agent-pool-name --name]
                                                 [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--ids]
                                                 [--interval]
                                                 [--kc-name --kubernetes-cluster-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--agent-pool-name --name -n

Kubernetes 群集代理池的名称。

属性 值
Parameter group: Resource Id Arguments
--created

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

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

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

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

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

属性 值
Parameter group: Resource Id Arguments
--interval

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--kc-name --kubernetes-cluster-name

Kubernetes 群集的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--timeout

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

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

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

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

显示此帮助消息并退出。

--only-show-errors

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

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

Output format.

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

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

--verbose

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

属性 值
默认值: False