Share via

az networkcloud kubernetescluster agentpool

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az networkcloud kubernetescluster agentpool command. Learn more about extensions.

Manage Kubernetes cluster's agent pool.

Commands

Name Description Type Status
az networkcloud kubernetescluster agentpool create

Create a new Kubernetes cluster agent pool or update the properties of the existing one.

 Extension GA
az networkcloud kubernetescluster agentpool delete

Delete the provided Kubernetes cluster agent pool.

 Extension GA
az networkcloud kubernetescluster agentpool list

List agent pools for the provided Kubernetes cluster.

 Extension GA
az networkcloud kubernetescluster agentpool show

Get properties of the provided Kubernetes cluster agent pool.

 Extension GA
az networkcloud kubernetescluster agentpool update

Update the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.

 Extension GA
az networkcloud kubernetescluster agentpool wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az networkcloud kubernetescluster agentpool create

Create a new Kubernetes cluster agent pool or update the properties of the existing one.

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]

Examples

Create or update agent pool of the Kubernetes cluster

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']"

Required Parameters

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

The name of the Kubernetes cluster agent pool.

--count

The number of virtual machines that use this configuration.

Property Value
Parameter group: Properties Arguments
--kc-name --kubernetes-cluster-name

The name of the Kubernetes cluster.

--mode

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.

Property Value
Parameter group: Properties Arguments
Accepted values: NotApplicable, System, User
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vm-sku-name

The name of the VM SKU that determines the size of resources allocated for node VMs.

Property Value
Parameter group: Properties Arguments

Optional Parameters

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

--admin-username

The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.

Property Value
Parameter group: AdministratorConfiguration Arguments
--agent-options

The configurations that will be applied to each agent in this agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--attached-network-configuration

The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. These networks are in addition to the networks connected in the Kubernetes cluster attached network configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--availability-zones

The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--extended-___location

The extended ___location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AgentPoolParameters Arguments
--generate-ssh-keys

Generate SSH public and private key files if missing. The keys will be stored under '~/.ssh'.

Property Value
Parameter group: AdministratorConfiguration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--labels

The labels applied to the nodes in this agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--___location -l

The geo-___location where the resource lives When not specified, the ___location of the resource group will be used.

Property Value
Parameter group: AgentPoolParameters Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ssh-dest-key-path

The list of space-separated paths to ssh public keys. A file path can be provided or a directory. If a directory is provided will attempt to load all the public keys (.pub) found. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AdministratorConfiguration Arguments
--ssh-key-values

The list of space-separated SSH public keys. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AdministratorConfiguration Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AgentPoolParameters Arguments
--taints

The taints applied to the nodes in this agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--upgrade-settings

The configuration of the agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud kubernetescluster agentpool delete

Delete the provided Kubernetes cluster agent pool.

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]

Examples

Delete agent pool of the Kubernetes cluster

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

Optional Parameters

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

The name of the Kubernetes cluster agent pool.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

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

The name of the Kubernetes cluster.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud kubernetescluster agentpool list

List agent pools for the provided Kubernetes cluster.

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

Examples

List agent pools of the Kubernetes cluster

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

Required Parameters

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

The name of the Kubernetes cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud kubernetescluster agentpool show

Get properties of the provided Kubernetes cluster agent pool.

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

Examples

Get agent pool of the Kubernetes cluster

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

Optional Parameters

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

The name of the Kubernetes cluster agent pool.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--kc-name --kubernetes-cluster-name

The name of the Kubernetes cluster.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud kubernetescluster agentpool update

Update the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.

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]

Examples

Patch agent pool of the Kubernetes cluster

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

Update Agent pool administrator credentials

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

Optional Parameters

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

The name of the Kubernetes cluster agent pool.

Property Value
Parameter group: Resource Id Arguments
--count

The number of virtual machines that use this configuration.

Property Value
Parameter group: Properties Arguments
--generate-ssh-keys

Generate SSH public and private key files if missing. The keys will be stored under '~/.ssh'.

Property Value
Parameter group: AdministratorConfiguration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

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

The name of the Kubernetes cluster.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--ssh-dest-key-path

The list of space-separated paths to ssh public keys. A file path can be provided or a directory. If a directory is provided will attempt to load all the public keys (.pub) found. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AdministratorConfiguration Arguments
--ssh-key-values

The list of space-separated SSH public keys. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AdministratorConfiguration Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: AgentPoolUpdateParameters Arguments
--upgrade-settings

The configuration of the agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud kubernetescluster agentpool wait

Place the CLI in a waiting state until a condition is met.

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]

Optional Parameters

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

The name of the Kubernetes cluster agent pool.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--kc-name --kubernetes-cluster-name

The name of the Kubernetes cluster.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False