Share via

az hdinsight application

Manage HDInsight applications.

We no longer maintain module before version 2.30.0. It is recommended to upgrade to at least version 2.30.0.

Commands

Name Description Type Status
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 application create

Edit

Create an application for a HDInsight cluster.

az hdinsight application create --cluster-name
                                --name
                                --resource-group
                                --script-action-name
                                --script-uri
                                [--access-mode]
                                [--destination-port]
                                [--disable-gateway-auth {false, true}]
                                [--edgenode-size]
                                [--marketplace-id]
                                [--no-validation-timeout]
                                [--script-parameters]
                                [--ssh-password]
                                [--ssh-public-key]
                                [--ssh-user]
                                [--sub-domain-suffix]
                                [--subnet]
                                [--tags]
                                [--type {CustomApplication, RServer}]
                                [--vnet-name]

Examples

Create an application with a script URI.

az hdinsight application create -g MyResourceGroup -n MyApplication \
--cluster-name MyCluster \
--script-uri https://hdiconfigactions.blob.core.windows.net/linuxhueconfigactionv02/install-hue-uber-v02.sh \
--script-action-name MyScriptAction \
--script-parameters '"-version latest -port 20000"'

Create an application with a script URI and specified edge node size.

az hdinsight application create -g MyResourceGroup -n MyApplication \
--cluster-name MyCluster \
--script-uri https://hdiconfigactions.blob.core.windows.net/linuxhueconfigactionv02/install-hue-uber-v02.sh \
--script-action-name MyScriptAction \
--script-parameters "-version latest -port 20000" \
--edgenode-size Standard_D4_v2

Create an application with HTTPS Endpoint.

az hdinsight application create -g MyResourceGroup -n MyApplication \
--cluster-name MyCluster \
--script-uri https://hdiconfigactions.blob.core.windows.net/linuxhueconfigactionv02/install-hue-uber-v02.sh \
--script-action-name MyScriptAction \
--script-parameters "-version latest -port 20000" \
--destination-port 8888 \
--sub-domain-suffix was

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The constant value for the application name.

--resource-group -g

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

--script-action-name

The name of the script action.

Property Value
Parameter group: Script Action Arguments
--script-uri

The URI to the script.

Property Value
Parameter group: Script Action Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-mode

The access mode for the application.

Property Value
Parameter group: HTTPS Endpoint Arguments
Default value: WebPage
--destination-port

The destination port to connect to.

Property Value
Parameter group: HTTPS Endpoint Arguments
Default value: 8080
--disable-gateway-auth

Indicates whether to disable gateway authentication. Default is to enable gateway authentication. Default: false.

Property Value
Parameter group: HTTPS Endpoint Arguments
Accepted values: false, true
--edgenode-size

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

Property Value
Parameter group: Node Arguments
Default value: Standard_D3_V2
--marketplace-id

The marketplace identifier.

--no-validation-timeout

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

Property Value
Default value: False
--script-parameters

The parameters for the script.

Property Value
Parameter group: Script Action Arguments
--ssh-password -P

SSH password for the cluster nodes.

Property Value
Parameter group: SSH Arguments
--ssh-public-key -K

SSH public key for the cluster nodes.

Property Value
Parameter group: SSH Arguments
--ssh-user -U

SSH username for the cluster nodes.

Property Value
Parameter group: SSH Arguments
Default value: sshuser
--sub-domain-suffix

The subdomain suffix of the application.

Property Value
Parameter group: HTTPS Endpoint Arguments
--subnet

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

Property Value
Parameter group: Network Arguments
--tags

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

--type -t

The application type.

Property Value
Default value: CustomApplication
Accepted values: CustomApplication, RServer
--vnet-name

The name of a virtual network.

Property Value
Parameter group: Network Arguments
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 hdinsight application delete

Edit

Deletes the specified application on the HDInsight cluster.

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

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The constant value for the application 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.

--no-wait

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

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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 hdinsight application list

Edit

Lists all of the applications for the HDInsight cluster.

az hdinsight application list --cluster-name
                              --resource-group

Required Parameters

--cluster-name

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.

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 hdinsight application show

Edit

Gets properties of the specified application.

az hdinsight application show --cluster-name
                              --name
                              --resource-group

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The constant value for the application 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

az hdinsight application wait

Edit

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

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

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The constant value for the application 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.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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