Edit

Share via

Set-AzureRmHDInsightPersistedScriptAction

  • Reference
Module:
AzureRM.HDInsight

Sets a previously executed script action to be a persisted script action.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Set-AzureRmHDInsightPersistedScriptAction
   [-ClusterName] <String>
   [-ScriptExecutionId] <Int64>
   [-ResourceGroupName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Set-AzureRmHDInsightPersistedScriptAction cmdlet sets a previously executed script action to be a persisted script action. The specified script action must have previously succeeded. The script action will run each time the Azure HDInsight cluster is scaled up.

Examples

Example 1: Set a previously successful script action to be persisted, or run on cluster scale up

PS C:\>Set-AzureRmHDInsightPersistedScriptAction `
            -ClusterName "your-hadoop-001" `
            -ScriptExecutionId "<id>"

This command sets a previously successful script action to be a persisted script action.

Parameters

-ClusterName

Specifies the name of the cluster.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of the resource group.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScriptExecutionId

Specifies the execution ID of the script action to promote to persisted. This script action must have succeeded in order to be promoted. You can find the script action execution ID using Get-AzureRmHDInsightScriptActionHistory.

Type:Int64
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Void