Start-​Azure​Automation​Runbook

Starts a runbook job.

Syntax

Start-AzureAutomationRunbook
     -AutomationAccountName <String>
     -Name <String>
     [-Parameters <IDictionary>]
     [-Profile <AzureSMProfile>]
     [-RunOn <String>]
     [<CommonParameters>]

Description

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

Examples

Example 1: Start a runbook job

PS C:\> Start-AzureAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01"

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

Required Parameters

-AutomationAccountName

Specifies the name of an Automation account.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of a runbook.

Type:String
Aliases:RunbookName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Parameters
Type:IDictionary
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunOn
Type:String
Aliases:HybridWorker
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Automation.Model.Job