az hdinsight-on-aks cluster upgrade

Note

This reference is part of the hdinsightonaks extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az hdinsight-on-aks cluster upgrade command. Learn more about extensions.

Command group 'az hdinsight-on-aks cluster' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Upgrade cluster.

Commands

Name	Description	Type	Status
az hdinsight-on-aks cluster upgrade history	List a list of upgrade history.	Extension	Preview
az hdinsight-on-aks cluster upgrade list	List a cluster available upgrades.	Extension	Preview
az hdinsight-on-aks cluster upgrade rollback	Manual rollback upgrade for a cluster.	Extension	Preview
az hdinsight-on-aks cluster upgrade run	Upgrade a cluster.	Extension	Preview

az hdinsight-on-aks cluster upgrade history

Preview

Command group 'az hdinsight-on-aks cluster upgrade' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a list of upgrade history.

az hdinsight-on-aks cluster upgrade history --cluster-name
                                            --cluster-pool-name
                                            --resource-group
                                            [--max-items]
                                            [--next-token]

Examples

List the upgrade records of the cluster.

az hdinsight-on-aks cluster upgrade history -g {resourcesGroup} --cluster-pool-name {poolName} --cluster-name {clusterName}

Required Parameters

--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

--resource-group -g

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

Optional Parameters

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

--next-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az hdinsight-on-aks cluster upgrade list

Preview

Command group 'az hdinsight-on-aks cluster upgrade' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a cluster available upgrades.

az hdinsight-on-aks cluster upgrade list --cluster-name
                                         --cluster-pool-name
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List the cluster available upgrades.

az hdinsight-on-aks cluster upgrade list -g {resourcesGroup} --cluster-pool-name {poolName} --cluster-name {clusterName}

Required Parameters

--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

--resource-group -g

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

Optional Parameters

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

--next-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az hdinsight-on-aks cluster upgrade rollback

Preview

Command group 'az hdinsight-on-aks cluster upgrade' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manual rollback upgrade for a cluster.

az hdinsight-on-aks cluster upgrade rollback --upgrade-history
                                             [--cluster-name]
                                             [--cluster-pool-name]
                                             [--ids]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--subscription]

Examples

Rollback the upgrade to a cluster.

az hdinsight-on-aks cluster upgrade rollback -g {resourcesGroup} --cluster-pool-name {poolName} --cluster-name {clusterName} --upgrade-history {history string}

Required Parameters

--upgrade-history

A specific upgrade history to rollback.

Optional Parameters

--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

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

--no-wait

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

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az hdinsight-on-aks cluster upgrade run

Preview

Command group 'az hdinsight-on-aks cluster upgrade' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Upgrade a cluster.

az hdinsight-on-aks cluster upgrade run [--aks-patch-upgrade]
                                        [--cluster-name]
                                        [--cluster-pool-name]
                                        [--hotfix-upgrade]
                                        [--ids]
                                        [--in-place-upgrade]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--patch-version-upgrade]
                                        [--resource-group]
                                        [--subscription]

Examples

Upgrade a cluster, use command 'az hdinsight-on-aks cluster upgrade list' get upgrades list.

az hdinsight-on-aks cluster upgrade run -g {resourcesGroup} --cluster-pool-name {poolName} --cluster-name {clusterName} --hotfix-upgrade component-name={componentName} target-build-number={targetBuildNumber} target-cluster-version={targetClusterVersion} target-oss-version={targetOssVersion}

Optional Parameters

--aks-patch-upgrade

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

--cluster-name

The name of the HDInsight cluster.

--cluster-pool-name

The name of the cluster pool.

--hotfix-upgrade

Properties of upgrading cluster's hotfix. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--in-place-upgrade

Properties of in-place upgrading cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--patch-version-upgrade

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

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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