script_actions

Creates, updates, deletes, gets or lists a script_actions resource.

Overview

Name	script_actions
Type	Resource
Id	azure.hdinsight.script_actions

Fields

The following fields are returned by SELECT queries:

get_execution_async_operation_status

Name	Datatype	Description
error	object	The error message associated with the cluster creation.
status	string	The async operation state. Known values are: "InProgress", "Succeeded", and "Failed". (InProgress, Succeeded, Failed)

get_execution_detail

Name	Datatype	Description
name	string	The name of the script action. Required.
applicationName	string	The application name of the script action, if any.
debugInformation	string	The script action execution debug information.
endTime	string	The end time of script action execution.
executionSummary	array	The summary of script action execution result.
operation	string	The reason why the script action was executed.
parameters	string	The parameters for the script.
roles	array	The list of roles where script will be executed. Required.
scriptExecutionId	integer	The execution id of the script action.
startTime	string	The start time of script action execution.
status	string	The current execution status of the script action.
uri	string	The URI to the script. Required.

list_by_cluster

Name	Datatype	Description
name	string	The name of the script action. Required.
applicationName	string	The application name of the script action, if any.
debugInformation	string	The script action execution debug information.
endTime	string	The end time of script action execution.
executionSummary	array	The summary of script action execution result.
operation	string	The reason why the script action was executed.
parameters	string	The parameters for the script.
roles	array	The list of roles where script will be executed. Required.
scriptExecutionId	integer	The execution id of the script action.
startTime	string	The start time of script action execution.
status	string	The current execution status of the script action.
uri	string	The URI to the script. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_execution_async_operation_status	select	resource_group_name, cluster_name, operation_id, subscription_id		Gets the async operation status of execution operation.
get_execution_detail	select	resource_group_name, cluster_name, script_execution_id, subscription_id		Gets the script execution detail for the given script execution ID.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		Lists all the persisted script actions for the specified cluster.
delete	delete	resource_group_name, cluster_name, script_name, subscription_id		Deletes a specified persisted script action of the cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the cluster. Required.
operation_id	string	The long running operation id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
script_execution_id	string	The script execution Id. Required.
script_name	string	The name of the script. Required.
subscription_id	string

SELECT examples

get_execution_async_operation_status

Gets the async operation status of execution operation.

SELECT
error,
status
FROM azure.hdinsight.script_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_execution_detail

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

SELECT
name,
applicationName,
debugInformation,
endTime,
executionSummary,
operation,
parameters,
roles,
scriptExecutionId,
startTime,
status,
uri
FROM azure.hdinsight.script_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND script_execution_id = '{{ script_execution_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Lists all the persisted script actions for the specified cluster.

SELECT
name,
applicationName,
debugInformation,
endTime,
executionSummary,
operation,
parameters,
roles,
scriptExecutionId,
startTime,
status,
uri
FROM azure.hdinsight.script_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Deletes a specified persisted script action of the cluster.

DELETE FROM azure.hdinsight.script_actions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND script_name = '{{ script_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;