az networkcloud kubernetescluster agentpool
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az networkcloud kubernetescluster agentpool command. Learn more about extensions.
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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 | Preview |
| az networkcloud kubernetescluster agentpool delete |
Delete the provided Kubernetes cluster agent pool. |
Extension | Preview |
| az networkcloud kubernetescluster agentpool list |
List agent pools for the provided Kubernetes cluster. |
Extension | Preview |
| az networkcloud kubernetescluster agentpool show |
Get properties of the provided Kubernetes cluster agent pool. |
Extension | Preview |
| 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 | Preview |
| az networkcloud kubernetescluster agentpool wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az networkcloud kubernetescluster agentpool create
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a new Kubernetes cluster agent pool or update the properties of the existing one.
az networkcloud kubernetescluster agentpool create --agent-pool-name
--count
--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}]
[--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
The name of the Kubernetes cluster agent pool.
The number of virtual machines that use this configuration.
The name of the Kubernetes cluster.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the VM SKU that determines the size of resources allocated for node VMs.
Optional Parameters
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.
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.
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.
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.
The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Generate SSH public and private key files if missing. The keys will be stored under '~/.ssh'.
The labels applied to the nodes in this agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
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.
The list of space-separated SSH public keys. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The taints applied to the nodes in this agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The configuration of the agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud kubernetescluster agentpool delete
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete the provided Kubernetes cluster agent pool.
az networkcloud kubernetescluster agentpool delete [--agent-pool-name]
[--ids]
[--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 name of the Kubernetes cluster agent pool.
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.
The name of the Kubernetes cluster.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud kubernetescluster agentpool list
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List agent pools for the provided Kubernetes cluster.
az networkcloud kubernetescluster agentpool list --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
The name of the Kubernetes cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud kubernetescluster agentpool show
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get properties of the provided Kubernetes cluster agent pool.
az networkcloud kubernetescluster agentpool show [--agent-pool-name]
[--ids]
[--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 name of the Kubernetes cluster agent pool.
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.
The name of the Kubernetes cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud kubernetescluster agentpool update
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]
[--count]
[--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--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 name of the Kubernetes cluster agent pool.
The number of virtual machines that use this configuration.
Generate SSH public and private key files if missing. The keys will be stored under '~/.ssh'.
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.
The name of the Kubernetes cluster.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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.
The list of space-separated SSH public keys. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The configuration of the agent pool. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az networkcloud kubernetescluster agentpool wait
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az networkcloud kubernetescluster agentpool wait [--agent-pool-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--kubernetes-cluster-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of the Kubernetes cluster agent pool.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the Kubernetes cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for