Share via

az hdinsight script-action

  • Reference

Manage HDInsight script actions.

Commands

Name Description Type Status
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 script-action delete

Edit

Deletes a specified persisted script action of the cluster.

az hdinsight script-action delete --cluster-name
                                  --name
                                  --resource-group

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The name of the script.

--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 script-action execute

Edit

Execute script actions on the specified HDInsight cluster.

az hdinsight script-action execute --cluster-name
                                   --name
                                   --resource-group
                                   --roles
                                   --script-uri
                                   [--persist-on-success]
                                   [--script-parameters]

Examples

Execute a script action and persist on success.

az hdinsight script-action execute -g MyResourceGroup -n MyScriptActionName \
--cluster-name MyCluster \
--script-uri https://hdiconfigactions.blob.core.windows.net/linuxgiraphconfigactionv01/giraph-installer-v01.sh \
--roles headnode workernode \
--persist-on-success

Required Parameters

--cluster-name

The name of the cluster.

--name -n

The name of the script action.

--resource-group -g

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

--roles

A space-delimited list of roles (nodes) where the script will be executed. Valid roles are headnode, workernode, zookeepernode, edgenode.

--script-uri

The URI to the script.

Optional Parameters

--persist-on-success

If the scripts needs to be persisted.

Default value: False
--script-parameters

The parameters for the script.

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 script-action list

Edit

Lists all the persisted script actions for the specified cluster.

az hdinsight script-action 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.

--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 script-action list-execution-history

Edit

Lists all scripts' execution history for the specified cluster.

az hdinsight script-action list-execution-history --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.

--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 script-action promote

Edit

Promotes the specified ad-hoc script execution to a persisted script.

az hdinsight script-action promote --cluster-name
                                   --execution-id
                                   --resource-group

Required Parameters

--cluster-name

The name of the cluster.

--execution-id

The script execution id.

--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 script-action show-execution-details

Edit

Gets the script execution detail for the given script execution ID.

az hdinsight script-action show-execution-details --cluster-name
                                                  --execution-id
                                                  --resource-group

Required Parameters

--cluster-name

The name of the cluster.

--execution-id

The script execution id.

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