< Back

Submit-AzureRmHDInsightScriptAction

Tue Jan 29, 2019 9:48 pm

NAME Submit-AzureRmHDInsightScriptAction



SYNOPSIS

Submits a new script action to an Azure HDInsight cluster.





SYNTAX

Submit-AzureRmHDInsightScriptAction [-ClusterName] <String> [-Name] <String> [-Uri] <Uri> [-NodeTypes] {HeadNode | WorkerNode | ZookeeperNode |

EdgeNode} [[-Parameters] <String>] [[-ApplicationName] <String>] [[-PersistOnSuccess]] [-DefaultProfile <IAzureContextContainer>]

[-ResourceGroupName <String>] [<CommonParameters>]





DESCRIPTION

The Submit-AzureRmHDInsightScriptAction cmdlet submits a new script action to an Azure HDInsight cluster. Use PersistOnSuccess to have the script

action run each time the cluster is scaled up, as long as the script action initially succeeds.





PARAMETERS

-ApplicationName <String>

Specifies the application name for the script action. When ApplicationName is specified, PersistOnSuccess should be set to False, nodes must

contain only edgenode, and script action count should equal 1.



Required? false

Position? 5

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ClusterName <String>

Specifies the name of the cluster.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the script action.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-NodeTypes <RuntimeScriptActionClusterNodeType[]>

Specifies the node types on which to run the script action.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Parameters <String>

Specifies the parameters for the script action.



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PersistOnSuccess [<SwitchParameter>]

Indicates that the script action should run each time the cluster is scaled up. This switch parameter is ignored if the script action

initially fails.



Required? false

Position? 6

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Uri <Uri>

Specifies the public URI for the script action (a PowerShell or Bash script).



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.HDInsight.Models.Management.AzureHDInsightRuntimeScriptActionOperationResource







NOTES









Example 1: Submit a new script action to a running HDInsight cluster



PS C:\\>Submit-AzureRmHDInsightScriptAction `

-ClusterName "your-hadoop-001" `

-Name "scriptaction" `

-Uri "<script action URI>" `

-NodeTypes Worker -PersistOnSuccess



This command submits a script action to a running HDInsight cluster.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... riptaction

Add-AzureRmHDInsightScriptAction