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
 

Get-AzureAutomationRunbook

Get-AzureAutomationRunbook

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

Synopsis

Gets a runbook.

Syntax

Get-AzureAutomationRunbook [-AutomationAccountName] [<CommonParameters>]

Get-AzureAutomationRunbook [-AutomationAccountName] [-Id] [<CommonParameters>]

Get-AzureAutomationRunbook [-AutomationAccountName] [-Name] [<CommonParameters>]

Get-AzureAutomationRunbook [-AutomationAccountName] [-ScheduleName] [<CommonParameters>]

Detailed Description

The Get-AzureAutomationRunbook cmdlet gets one or more Microsoft Azure Automation runbooks. By default, all runbooks are returned. To get a specific runbook, specify its name or ID. To get all runbooks linked to a specific schedule, specify the schedule name.

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

-ScheduleName <String>

Specifies the name of a schedule.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Get all runbooks

This command gets all runbooks in the Azure Automation account named Contoso17.

PS C:\>Get-AzureAutomationRunbook -AutomationAccountName "Contoso17" 

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