Start-AzAutomationRunbook

Module:

Az.Automation Module

Starts a runbook job.

Start-AzAutomationRunbook
 [-Name] <String>
 [-ResourceGroupName] <String>
 [-AutomationAccountName] <String>
 [-Parameters <IDictionary>]
 [-RunOn <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Start-AzAutomationRunbook
 [-Name] <String>
 [-ResourceGroupName] <String>
 [-AutomationAccountName] <String>
 [-Parameters <IDictionary>]
 [-RunOn <String>]
 [-Wait]
 [-MaxWaitSeconds <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

The Start-AzAutomationRunbook cmdlet starts an Azure Automation runbook job. Specify the ID or name of a runbook.

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17.

$params = [ordered]@{"Key1"="ValueForPosition1";"Key2"="ValueForPosition2"}
Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "RunbkPy01" -ResourceGroupName "ResourceGroup01" -Parameters $params

This command starts a runbook job for the Python 2 runbook named RunbkPy01 in the Azure Automation account named Contoso17 with "ValueForPosition1" as the first positional parameter and "ValueForPosition2" for the second one.

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -MaxWaitSeconds 1000 -Wait

This command starts a runbook job for the runbook named Runbk01 in the Azure Automation account named Contoso17. This command specifies the Wait parameter. Therefore, it returns results after the job is completed. The cmdlet waits up to 1000 seconds for the results.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.