az hdinsight

Reference

Manage HDInsight resources.

Commands

Name	Description	Type	Status
az hdinsight application	Manage HDInsight applications.	Core	GA
az hdinsight application create	Create an application for a HDInsight cluster.	Core	GA
az hdinsight application delete	Deletes the specified application on the HDInsight cluster.	Core	GA
az hdinsight application list	Lists all of the applications for the HDInsight cluster.	Core	GA
az hdinsight application show	Gets properties of the specified application.	Core	GA
az hdinsight application wait	Place the CLI in a waiting state until an operation is complete.	Core	GA
az hdinsight autoscale	Manage HDInsight cluster's Autoscale configuration.	Core	GA
az hdinsight autoscale condition	Manage schedule condition of the HDInsight cluster which enabled Schedule-based Autoscale.	Core	GA
az hdinsight autoscale condition create	Add a new schedule condition.	Core	GA
az hdinsight autoscale condition delete	Delete schedule condition.	Core	GA
az hdinsight autoscale condition list	List all schedule conditions.	Core	GA
az hdinsight autoscale condition update	Update a schedule condition.	Core	GA
az hdinsight autoscale condition wait	Place the CLI in a waiting state until an operation is complete.	Core	GA
az hdinsight autoscale create	Enable Autoscale for a running cluster.	Core	GA
az hdinsight autoscale delete	Disable Autoscale for a running cluster.	Core	GA
az hdinsight autoscale list-timezones	List the available timezone name when enabling Schedule-based Autoscale.	Core	GA
az hdinsight autoscale show	Get the Autoscale configuration of a specified cluster.	Core	GA
az hdinsight autoscale update	Update the Autoscale configuration.	Core	GA
az hdinsight autoscale wait	Place the CLI in a waiting state until an operation is complete.	Core	GA
az hdinsight azure-monitor	Manage Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor-agent	Manage Azure Monitor Agent logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor-agent disable	Disable the Azure Monitor Agent logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor-agent enable	Enable the Azure Monitor Agent logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor-agent show	Get the status of Azure Monitor Agent logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor disable	Disable the Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor enable	Enable the Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight azure-monitor show	Get the status of Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight create	Create a new cluster.	Core	GA
az hdinsight delete	Deletes the specified HDInsight cluster.	Core	GA
az hdinsight host	Manage HDInsight cluster's virtual hosts.	Core	GA
az hdinsight host list	List the hosts of the specified HDInsight cluster.	Core	GA
az hdinsight host restart	Restart the specific hosts of the specified HDInsight cluster.	Core	GA
az hdinsight list	List HDInsight clusters in a resource group or subscription.	Core	GA
az hdinsight list-usage	Lists the usages for the specified location.	Core	GA
az hdinsight monitor	Manage Classic Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight monitor disable	Disable the Classic Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight monitor enable	Enable the Classic Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight monitor show	Get the status of Classic Azure Monitor logs integration on an HDInsight cluster.	Core	GA
az hdinsight resize	Resize the specified HDInsight cluster to the specified size.	Core	GA
az hdinsight rotate-disk-encryption-key	Rotate the disk encryption key of the specified HDInsight cluster.	Core	GA
az hdinsight script-action	Manage HDInsight script actions.	Core	GA
az hdinsight script-action delete	Deletes a specified persisted script action of the cluster.	Core	GA
az hdinsight script-action execute	Execute script actions on the specified HDInsight cluster.	Core	GA
az hdinsight script-action list	Lists all the persisted script actions for the specified cluster.	Core	GA
az hdinsight script-action list-execution-history	Lists all scripts' execution history for the specified cluster.	Core	GA
az hdinsight script-action promote	Promotes the specified ad-hoc script execution to a persisted script.	Core	GA
az hdinsight script-action show-execution-details	Gets the script execution detail for the given script execution ID.	Core	GA
az hdinsight show	Gets the specified cluster.	Core	GA
az hdinsight update	Update the tags or identity of the specified HDInsight cluster. Setting the identity property will override the existing identity configuration of the cluster.	Core	GA
az hdinsight wait	Place the CLI in a waiting state until an operation is complete.	Core	GA

az hdinsight create

Edit

Create a new cluster.

az hdinsight create --name
                    --resource-group
                    --type
                    [--assign-identity]
                    [--autoscale-count]
                    [--autoscale-max-count]
                    [--autoscale-min-count]
                    [--autoscale-type {Load, Schedule}]
                    [--cluster-admin-account]
                    [--cluster-admin-password]
                    [--cluster-configurations]
                    [--cluster-tier {Premium, Standard}]
                    [--cluster-users-group-dns]
                    [--component-version]
                    [--compute-isolation {false, true}]
                    [--days {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                    [--domain]
                    [--edgenode-size]
                    [--enable-private-link {false, true}]
                    [--encryption-algorithm {RSA-OAEP, RSA-OAEP-256, RSA1_5}]
                    [--encryption-at-host {false, true}]
                    [--encryption-in-transit {false, true}]
                    [--encryption-key-name]
                    [--encryption-key-version]
                    [--encryption-vault-uri]
                    [--esp]
                    [--headnode-size]
                    [--host-sku]
                    [--http-password]
                    [--http-user]
                    [--idbroker]
                    [--kafka-client-group-id]
                    [--kafka-client-group-name]
                    [--kafka-management-node-count]
                    [--kafka-management-node-size]
                    [--ldaps-urls]
                    [--location]
                    [--minimal-tls-version {1.2}]
                    [--no-validation-timeout]
                    [--no-wait]
                    [--outbound-dependencies-managed-type {External, Managed}]
                    [--private-link-config]
                    [--public-ip-tag-type]
                    [--public-ip-tag-value]
                    [--resource-provider-connection {Inbound, Outbound}]
                    [--ssh-password]
                    [--ssh-public-key]
                    [--ssh-user]
                    [--storage-account]
                    [--storage-account-key]
                    [--storage-account-managed-identity]
                    [--storage-container]
                    [--storage-filesystem]
                    [--subnet]
                    [--tags]
                    [--time]
                    [--timezone]
                    [--version]
                    [--vnet-name]
                    [--workernode-count]
                    [--workernode-data-disk-size]
                    [--workernode-data-disk-storage-account-type {premium_lrs, standard_lrs}]
                    [--workernode-data-disks-per-node]
                    [--workernode-size]
                    [--zones]
                    [--zookeepernode-size]

Examples

Create a cluster with an existing storage account.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount

Create a cluster with minimal tls version.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount --minimal-tls-version 1.2

Create a cluster which enables encryption in transit.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount --encryption-in-transit true

Create a cluster with encryption at host.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount --encryption-at-host true

Create a cluster with the Enterprise Security Package (ESP).

az hdinsight create --esp -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount \
--subnet "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/subnet1" \
--domain "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.AAD/domainServices/MyDomain.onmicrosoft.com" \
--assign-identity "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MyMsiRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyMSI" \
--cluster-admin-account MyAdminAccount@MyDomain.onmicrosoft.com \
--cluster-users-group-dns MyGroup

Create a cluster with the Enterprise Security Package (ESP) and enable HDInsight ID Broker.

az hdinsight create --esp --idbroker -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount \
--subnet "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnet/subnets/subnet1" \
--domain "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.AAD/domainServices/MyDomain.onmicrosoft.com" \
--assign-identity "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/MyMsiRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyMSI" \
--cluster-admin-account MyAdminAccount@MyDomain.onmicrosoft.com \
--cluster-users-group-dns MyGroup

Create a Kafka cluster with disk encryption. See https://docs.microsoft.com/azure/hdinsight/kafka/apache-kafka-byok.

az hdinsight create -t kafka -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --workernode-data-disks-per-node 2 \
--storage-account MyStorageAccount \
--encryption-key-name kafkaClusterKey \
--encryption-key-version 00000000000000000000000000000000 \
--encryption-vault-uri https://MyKeyVault.vault.azure.net \
--assign-identity MyMSI

Create a kafka cluster with kafka rest proxy.

az hdinsight create -t kafka -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --workernode-data-disks-per-node 2 \
--storage-account MyStorageAccount \
--kafka-management-node-size "Standard_D4_v2" \
--kafka-client-group-id MySecurityGroupId \
--kafka-client-group-name MySecurityGroupName
--component-version kafka=2.1

Create a cluster with Azure Data Lake Storage Gen2

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount \
--storage-account-managed-identity MyMSI

Create a cluster with configuration from JSON string.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount \
--cluster-configuration {'gateway':{'restAuthCredential.username':'admin'}}

Create a cluster with configuration from a local file.

az hdinsight create -t spark -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" \
--storage-account MyStorageAccount \
--cluster-configuration @config.json

Create a cluster which Load-based Autoscale.

az hdinsight create -t spark --version 3.6 -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --storage-account MyStorageAccount \
--autoscale-type Load --autoscale-min-workernode-count 3 --autoscale-max-workernode-count 5

Create a cluster which Schedule-based Autoscale.

az hdinsight create -t spark --version 3.6 -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --storage-account MyStorageAccount \
--autoscale-type Schedule --timezone "Pacific Standard Time" --days Monday \
--time 09:00 --autoscale-workernode-count 5

Create a cluster with Relay Outbound and Private Link feature.

az hdinsight create -t spark --version 3.6 -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --storage-account MyStorageAccount \
--subnet "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/fakevnet/subnets/default" \
--resource-provider-connection Outbound --enable-private-link

Create a cluster with Compute Isolation feature.

az hdinsight create -t spark --version 3.6 -g MyResourceGroup -n MyCluster \
-p "HttpPassword1234!" --storage-account MyStorageAccount \
--enable-compute-isolation --workernode-size "Standard_E8S_V3" --headnode-size "Standard_E8S_V3"

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

--type -t

Type of HDInsight cluster, like: hadoop, interactivehive, hbase, kafka, storm, spark, rserver, mlservices. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#cluster-types.

Optional Parameters

--assign-identity

The name or ID of user assigned identity. Skip this field when assign_identity_type is SystemAssigned.

--autoscale-count --autoscale-workernode-count

The scheduled workernode count.

--autoscale-max-count --autoscale-max-workernode-count

The max workernode count for Load-based atuoscale.

--autoscale-min-count --autoscale-min-workernode-count

The minimal workernode count for Load-based atuoscale.

--autoscale-type

The autoscale type.

Accepted values: Load, Schedule

--cluster-admin-account

The domain user account that will have admin privileges on the cluster. Required only when create cluster with Enterprise Security Package.

--cluster-admin-password

The domain admin password. Required only when create cluster with Enterprise Security Package.

--cluster-configurations

Extra configurations of various components. Configurations may be supplied from a file using the @{path} syntax or a JSON string. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-customize-cluster-bootstrap.

--cluster-tier

The tier of the cluster.

Accepted values: Premium, Standard

--cluster-users-group-dns

A space-delimited list of Distinguished Names for cluster user groups. Required only when create cluster with Enterprise Security Package.

--component-version

The versions of various Hadoop components, in space-separated versions in 'component=version' format. Example: Spark=2.0 Hadoop=2.7.3 See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-component-versioning#hadoop-components-available-with-different-hdinsight-versions.

--compute-isolation --enable-compute-isolation

Indicate whether enable compute isolation or not.

Accepted values: false, true

--days

A space-delimited list of schedule day.

Accepted values: Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday

--domain

The name or resource ID of the user's Azure Active Directory Domain Service. Required only when create cluster with Enterprise Security Package.

--edgenode-size

The size of the node. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#configure-cluster-size.

--enable-private-link

Indicate whether enable the private link or not.

Accepted values: false, true

--encryption-algorithm

Algorithm identifier for encryption.

Accepted values: RSA-OAEP, RSA-OAEP-256, RSA1_5

Default value: RSA-OAEP

--encryption-at-host

Indicates whether enable encryption at host or not.

Accepted values: false, true

--encryption-in-transit

Indicates whether enable encryption in transit.

Accepted values: false, true

--encryption-key-name

Key name that is used for enabling disk encryption.

--encryption-key-version

Key version that is used for enabling disk encryption.

--encryption-vault-uri

Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net.

--esp

Specify to create cluster with Enterprise Security Package. If omitted, creating cluster with Enterprise Security Package will not not allowed.

Default value: False

--headnode-size

The size of the node. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#configure-cluster-size.

--host-sku

The dedicated host sku of compute isolation.

--http-password -p

HTTP password for the cluster. Will prompt if not given.

--http-user -u

HTTP username for the cluster. Default: admin.

--idbroker

Specify to create ESP cluster with HDInsight ID Broker. If omitted, creating ESP cluster with HDInsight ID Broker will not not allowed.

Default value: False

--kafka-client-group-id

The client AAD security group id for Kafka Rest Proxy.

--kafka-client-group-name

The client AAD security group name for Kafka Rest Proxy.

--kafka-management-node-count

The number of kafka management node in the cluster.

Default value: 2

--kafka-management-node-size

The size of the node. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#configure-cluster-size.

--ldaps-urls

A space-delimited list of LDAPS protocol URLs to communicate with the Active Directory. Required only when create cluster with Enterprise Security Package.

--location -l

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

--minimal-tls-version

The minimal supported TLS version.

Accepted values: 1.2

--no-validation-timeout

Permit timeout error during argument validation phase. If omitted, validation timeout error will be permitted.

Default value: False

--no-wait

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

Default value: False

--outbound-dependencies-managed-type --outbound-managed-type

The direction for the resource provider connection.

Accepted values: External, Managed

--private-link-config --private-link-configurations

The private link configurations when creating cluster. Private Link Configurations may be supplied from a file using the @{path} syntax or a JSON string. Please see https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/hdinsight/tests/latest/privatelinkconfigurations.json.

--public-ip-tag-type

Gets or sets the ipTag type: Example FirstPartyUsage.

--public-ip-tag-value

Gets or sets value of the IpTag associated with the public IP.Example HDInsight, SQL, Storage etc.

--resource-provider-connection --rp-connection

The resource provider connection type.

Accepted values: Inbound, Outbound

--ssh-password -P

SSH password for the cluster nodes. If none specified, uses the HTTP password.

--ssh-public-key -K

SSH public key for the cluster nodes.

--ssh-user -U

SSH username for the cluster nodes.

Default value: sshuser

--storage-account

The name or ID of the storage account.

--storage-account-key

The storage account key. A key can be retrieved automatically if the user has access to the storage account.

--storage-account-managed-identity

User-assigned managed identity with access to the storage account filesystem. Only required when storage account type is Azure Data Lake Storage Gen2.

--storage-container

The storage container the cluster will use. Uses the cluster name if none was specified. (WASB only).

--storage-filesystem

The storage filesystem the cluster will use. Uses the cluster name if none was specified. (DFS only).

--subnet

The name or ID of subnet. If name is supplied, --vnet-name must be supplied.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--time

The 24-hour time in the form of xx:xx in days.

--timezone

The timezone for schedule autoscale type. Values from az hdinsight autoscale list-timezones.

--version -v

The HDInsight cluster version. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-component-versioning#supported-hdinsight-versions.

Default value: default

--vnet-name

The name of a virtual network.

--workernode-count -c

The number of worker nodes in the cluster.

Default value: 3

--workernode-data-disk-size

The size of the data disk in GB, e.g. 1023.

--workernode-data-disk-storage-account-type

The type of storage account that will be used for the data disks: standard_lrs or premium_lrs.

Accepted values: premium_lrs, standard_lrs

--workernode-data-disks-per-node

The number of data disks to use per worker node.

--workernode-size

The size of the node. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#configure-cluster-size.

--zones

A space-delimited list of availability zones where cluster will be created.

--zookeepernode-size

The size of the node. See also: https://docs.microsoft.com/azure/hdinsight/hdinsight-hadoop-provision-linux-clusters#configure-cluster-size.

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 delete

Edit

Deletes the specified HDInsight cluster.

az hdinsight delete --name
                    --resource-group
                    [--no-wait]
                    [--yes]

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False

--yes -y

Do not prompt for confirmation.

Default value: False

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 list

Edit

List HDInsight clusters in a resource group or subscription.

az hdinsight list [--resource-group]

Optional Parameters

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

--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 list-usage

Edit

Lists the usages for the specified location.

az hdinsight list-usage --location

Required Parameters

--location -l

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

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 resize

Edit

Resize the specified HDInsight cluster to the specified size.

az hdinsight resize --name
                    --resource-group
                    --workernode-count
                    [--no-wait]

Examples

Resize the cluster's workernode.

az hdinsight resize --name MyCluster --resource-group rg --workernode-count 5

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

--workernode-count -c

The target worker node instance count for the operation.

Optional Parameters

--no-wait

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

Default value: False

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 rotate-disk-encryption-key

Edit

Rotate the disk encryption key of the specified HDInsight cluster.

az hdinsight rotate-disk-encryption-key --encryption-key-name
                                        --encryption-key-version
                                        --encryption-vault-uri
                                        --name
                                        --resource-group
                                        [--no-wait]

Required Parameters

--encryption-key-name

Key name that is used for enabling disk encryption.

--encryption-key-version

Key version that is used for enabling disk encryption.

--encryption-vault-uri

Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net.

--name -n

The name of the cluster.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False

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 show

Edit

Gets the specified cluster.

az hdinsight show --name
                  --resource-group

Required Parameters

--name -n

The name of the cluster.

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

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

Edit

Update the tags or identity of the specified HDInsight cluster. Setting the identity property will override the existing identity configuration of the cluster.

az hdinsight update --name
                    --resource-group
                    [--assign-identity]
                    [--assign-identity-type]
                    [--no-wait]
                    [--tags]

Examples

Update the tags.

az hdinsight update --name MyCluster --resource-group rg --tags key=value

Update manage identity with single UserAssigned msi.

az hdinsight update --name MyCluster --resource-group rg --assign-identity-type UserAssigned --assign-identity MyMsi

Update manage identity with multiple UserAssigned msi.

az hdinsight update --name MyCluster --resource-group rg --assign-identity-type UserAssigned --assign-identity MyMsi1 MyMsi2

Update SystemAssigned manage identity.

az hdinsight update --name MyCluster --resource-group rg --assign-identity-type SystemAssigned

Update manage identity with SystemAssigned,UserAssigned msi.

az hdinsight update --name MyCluster --resource-group rg --assign-identity-type "SystemAssigned,UserAssigned" --assign-identity MyMsi1

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

Optional Parameters

--assign-identity

The name or ID of user assigned identity. Skip this field when assign_identity_type is SystemAssigned.

--assign-identity-type

The type of identity used for the cluster. Allowed values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned.

--no-wait

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

Default value: False

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 wait

Edit

Place the CLI in a waiting state until an operation is complete.

az hdinsight wait --name
                  --resource-group
                  [--created]
                  [--custom]
                  [--deleted]
                  [--exists]
                  [--interval]
                  [--timeout]
                  [--updated]

Required Parameters

--name -n

The name of the cluster.

--resource-group -g

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

Optional Parameters

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--interval

Polling interval in seconds.

Default value: 30

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

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.

Share via

az hdinsight

Commands

az hdinsight create

Examples

Required Parameters

Optional Parameters

az hdinsight delete

Required Parameters

Optional Parameters

az hdinsight list

Optional Parameters

az hdinsight list-usage

Required Parameters

az hdinsight resize

Examples

Required Parameters

Optional Parameters

az hdinsight rotate-disk-encryption-key

Required Parameters

Optional Parameters

az hdinsight show

Required Parameters

az hdinsight update

Examples

Required Parameters

Optional Parameters

az hdinsight wait

Required Parameters

Optional Parameters

Additional resources