Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-AzureAutomationRunbook

Start-AzureAutomationRunbook

microsoft.windowsazure.commands.dll, microsoft.azure.commands.resourcemanager.automation.dll, microsoft.azure.commands.automation.dll

Synopsis

Starts a runbook job.

Syntax

Start-AzureAutomationRunbook [-AutomationAccountName] [-Parameters] [-Name] [<CommonParameters>]

Start-AzureAutomationRunbook [-AutomationAccountName] [-Parameters] [-Id] [<CommonParameters>]

Detailed Description

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

Parameters

-AutomationAccountName <String>

Specifies the name of an Azure Automation account.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Id <Guid>

Specifies the ID of a runbook.

Aliases

RunbookId

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of a runbook.

Aliases

RunbookName

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Parameters <IDictionary>

Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Start a runbook job

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

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

Online Version
Get-AzureAutomationRunbook
New-AzureAutomationRunbook
Publish-AzureAutomationRunbook
Remove-AzureAutomationRunbook
Set-AzureAutomationRunbook