az aks nodepool upgrade-insights

Note

This reference is part of the aks-preview extension for the Azure CLI (version 2.85.0 or higher). The extension will automatically install the first time you run an az aks nodepool upgrade-insights command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Evaluate Kubernetes or node-image upgrade readiness for one node pool.

These commands do not upgrade the pool. Issues are nested under the selected agent pool in the default readiness report. Use --output json for complete structured results. List all pool insights with az aks upgrade-insights list.

Commands

Name Description Type Status
az aks nodepool upgrade-insights create

Generate or refresh an upgrade readiness evaluation for one node pool.

Extension Preview
az aks nodepool upgrade-insights show

Read a stored AgentPool or NodeImage insight for the specified node pool.

Extension Preview

az aks nodepool upgrade-insights create

Preview

Command group 'aks nodepool upgrade-insights' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Generate or refresh an upgrade readiness evaluation for one node pool.

This command does not upgrade the pool. Displays a readiness report with issues nested under the selected pool by default. Use --output json for complete structured results.

az aks nodepool upgrade-insights create --cluster-name
                                        --name
                                        --resource-group
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--target-kubernetes-ver]
                                        [--target-node-image-ver]
                                        [--upgrade-type {AgentPool, NodeImage}]

Examples

Evaluate a Kubernetes version upgrade (the default upgrade type is AgentPool).

az aks nodepool upgrade-insights create -g MyResourceGroup --cluster-name MyCluster --name nodepool1 --target-kubernetes-ver 1.35.1

Evaluate the latest available node image.

az aks nodepool upgrade-insights create -g MyResourceGroup --cluster-name MyCluster --name nodepool1 --upgrade-type NodeImage

Evaluate a specific node image.

az aks nodepool upgrade-insights create -g MyResourceGroup --cluster-name MyCluster --name nodepool1 --upgrade-type NodeImage --target-node-image-ver NODE_IMAGE_VERSION

Required Parameters

--cluster-name

The managed cluster name.

--name -n

The node pool name.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--target-kubernetes-ver

The target Kubernetes version. Required for AgentPool.

--target-node-image-ver

The target node image version. Only valid for NodeImage; omitted means the latest available image.

--upgrade-type

The upgrade scope to evaluate. Defaults to an agent pool Kubernetes version upgrade.

Property Value
Default value: AgentPool
Accepted values: AgentPool, NodeImage
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 aks nodepool upgrade-insights show

Preview

Command group 'aks nodepool upgrade-insights' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Read a stored AgentPool or NodeImage insight for the specified node pool.

The insight must belong to the selected pool. To read a combined control-plane and agent-pools insight, use az aks upgrade-insights show. Displays a pool-nested readiness report by default; use --output json for complete structured results.

az aks nodepool upgrade-insights show --cluster-name
                                      --insight-name
                                      --name
                                      --resource-group

Examples

Read a stored node pool insight without regenerating it.

az aks nodepool upgrade-insights show -g MyResourceGroup --cluster-name MyCluster --name nodepool1 --insight-name INSIGHT_NAME

Required Parameters

--cluster-name

The managed cluster name.

--insight-name

The stored insight name returned by create or list.

--name -n

The node pool name.

--resource-group -g

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

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