Get-​Azure​Automation​Scheduled​Runbook

Gets Azure Automation runbooks and associated schedules.

Syntax

Get-AzureAutomationScheduledRunbook
   -AutomationAccountName <String>
   -JobScheduleId <Guid>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureAutomationScheduledRunbook
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   -RunbookName <String>
   [<CommonParameters>]
Get-AzureAutomationScheduledRunbook
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   -RunbookName <String>
   -ScheduleName <String>
   [<CommonParameters>]
Get-AzureAutomationScheduledRunbook
   -AutomationAccountName <String>
   [-Profile <AzureSMProfile>]
   -ScheduleName <String>
   [<CommonParameters>]

Description

The Get-AzureAutomationScheduledRunbook gets one or more Azure Automation runbooks and associated schedules. By default, all scheduled runbooks are returned.

To get a specific scheduled runbook, specify the runbook name and the schedule name. To get all schedules associated with a runbook, specify just the runbook name. To get all runbooks associated with a schedule, specify just the schedule name.

Examples

Example 1: Get all scheduled runbooks

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

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

Example 2: Get all schedules associated with a runbook

PS C:\> Get-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01"

This command gets all scheduled runbooks for the runbook Runbk01 in the Automation account named Contoso17.

Example 3: Get all runbooks associated with a schedule

PS C:\> Get-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ScheduleName "Schedule01"

This command gets all scheduled runbooks for the schedule Schedule01 in the Automation account named Contoso17.

Required Parameters

-AutomationAccountName

Specifies the name of an Azure Automation account.

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

Specifies the ID of a scheduled job.

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

Specifies the name of a runbook.

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

Specifies the name of a schedule.

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

Optional Parameters

-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

Outputs

Microsoft.Azure.Commands.Automation.Model.JobSchedule