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-AzureAutomationRunbookDefinition

Get-AzureAutomationRunbookDefinition

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

Synopsis

Gets a runbook definition.

Syntax

Get-AzureAutomationRunbookDefinition [-Name] [-Slot] [-AutomationAccountName] [<CommonParameters>]

Get-AzureAutomationRunbookDefinition [-Id] [-Slot] [-AutomationAccountName] [<CommonParameters>]

Get-AzureAutomationRunbookDefinition [-VersionId] [-Slot] [-AutomationAccountName] [<CommonParameters>]

Detailed Description

The Get-AzureAutomationRunbookDefinition cmdlet gets the draft definition, the published definition, or both definitions of an Azure Automation runbook. By default, both runbook definitions are returned.

Parameters

-Name <String>

Specifies the name of a runbook.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Slot <String>

Specifies a runbook definition type. Valid values are: -- Published -- Draft

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-AutomationAccountName <String>

Specifies the name of an Azure Automation account.

Aliases

None

Required?

true

Position

0

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Id <Nullable`1[Guid]>

Specifies the ID of a runbook.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VersionId <Nullable`1[Guid]>

Specifies the ID of a runbook version.

Aliases

None

Required?

true

Position

named

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1: Get a runbook definition --------------------------

This command gets the published runbook definition of the runbook named RunbookDef01 in the Azure Automation account named Contoso17.

PS C:\>Get-AzureAutomationRunbookDefinition -AutomationAccountName "Contoso17" -Name "RunbookDef01" -Slot "Published"

Online Version
Set-AzureAutomationRunbookDefinition