az hdinsight-on-aks

Note

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

HDInsight on Aks CLI.

Commands

Name Description Type Status
az hdinsight-on-aks check-name-availability

Check the availability of the resource name.

Extension Preview
az hdinsight-on-aks cluster

Cluster operations.

Extension Preview
az hdinsight-on-aks cluster create

Create a cluster.

Extension Preview
az hdinsight-on-aks cluster delete

Delete a cluster.

Extension Preview
az hdinsight-on-aks cluster instance-view

Gets the status of a cluster instances.

Extension Preview
az hdinsight-on-aks cluster instance-view list

List the lists of instance views.

Extension Preview
az hdinsight-on-aks cluster instance-view show

Get the status of a cluster instance.

Extension Preview
az hdinsight-on-aks cluster job

Cluster job operations.

Extension Preview
az hdinsight-on-aks cluster job list

List jobs of HDInsight on AKS cluster.

Extension Preview
az hdinsight-on-aks cluster job run

Operations on jobs of HDInsight on AKS cluster.

Extension Preview
az hdinsight-on-aks cluster list

List the HDInsight cluster pools under a resource group.

Extension Preview
az hdinsight-on-aks cluster list-service-config

List the config dump of all services running in cluster.

Extension Preview
az hdinsight-on-aks cluster node-profile

Manage compute node profile.

Extension Preview
az hdinsight-on-aks cluster node-profile create

Create a node profile with SKU and worker count.

Extension Preview
az hdinsight-on-aks cluster resize

Resize an existing Cluster.

Extension Preview
az hdinsight-on-aks cluster secret

Manage secret reference.

Extension Preview
az hdinsight-on-aks cluster secret create

Create a reference to provide a secret to store the password for accessing the database.

Extension Preview
az hdinsight-on-aks cluster show

Get a HDInsight cluster.

Extension Preview
az hdinsight-on-aks cluster trino-hive-catalog

Manage hive catalog config.

Extension Preview
az hdinsight-on-aks cluster trino-hive-catalog create

Create a hive catalog configured as a Trino cluster.

Extension Preview
az hdinsight-on-aks cluster update

Update a cluster.

Extension Preview
az hdinsight-on-aks cluster upgrade

Upgrade cluster.

Extension Preview
az hdinsight-on-aks cluster upgrade list

List a cluster available upgrades.

Extension Preview
az hdinsight-on-aks cluster upgrade run

Upgrade a cluster.

Extension Preview
az hdinsight-on-aks cluster wait

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

Extension Preview
az hdinsight-on-aks clusterpool

Clusterpool operations.

Extension Preview
az hdinsight-on-aks clusterpool create

Create a cluster pool.

Extension Preview
az hdinsight-on-aks clusterpool delete

Delete a Cluster Pool.

Extension Preview
az hdinsight-on-aks clusterpool list

List the list of Cluster Pools within a Subscription.

Extension Preview
az hdinsight-on-aks clusterpool show

Get a cluster pool.

Extension Preview
az hdinsight-on-aks clusterpool update

Update a cluster pool.

Extension Preview
az hdinsight-on-aks clusterpool upgrade

Upgrade clusterpool.

Extension Preview
az hdinsight-on-aks clusterpool upgrade list

List a cluster pool available upgrade.

Extension Preview
az hdinsight-on-aks clusterpool upgrade run

Upgrade a cluster pool.

Extension Preview
az hdinsight-on-aks clusterpool wait

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

Extension Preview
az hdinsight-on-aks list-available-cluster-pool-version

List a list of available cluster pool versions.

Extension Preview
az hdinsight-on-aks list-available-cluster-version

Get all hdinsightonaks available-cluster version.

Extension Preview

az hdinsight-on-aks check-name-availability

Preview

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

Check the availability of the resource name.

az hdinsight-on-aks check-name-availability [--ids]
                                            [--location]
                                            [--name]
                                            [--subscription]
                                            [--type]

Examples

Check if the name 'clicluster' is available in cluster pool 'cliclusterpool'.

az hdinsight-on-aks check-name-availability -l westus3 --name cliclusterpool/clicluster --type Microsoft.HDInsight/clusterPools/clusters

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name

Name for checking availability.

--subscription

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

--type

The resource type in Microsoft.HDInsight/clusterPools/clusters.

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 list-available-cluster-pool-version

Preview

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

List a list of available cluster pool versions.

az hdinsight-on-aks list-available-cluster-pool-version --location
                                                        [--max-items]
                                                        [--next-token]

Examples

Returns a list of available cluster pool versions.

az hdinsight-on-aks list-available-cluster-pool-version -l westus3

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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 list-available-cluster-version

Preview

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

Get all hdinsightonaks available-cluster version.

az hdinsight-on-aks list-available-cluster-version --location
                                                   [--max-items]
                                                   [--next-token]

Examples

Returns a list of available cluster versions.

az hdinsight-on-aks list-available-cluster-version -l westus3

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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.