Get-AzureRMAutomationScheduledRunbook

Reference

Module:: AzureRM.Automation

Gets Automation runbooks and associated schedules.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRMAutomationScheduledRunbook
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRMAutomationScheduledRunbook
   -JobScheduleId <Guid>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRMAutomationScheduledRunbook
   -RunbookName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRMAutomationScheduledRunbook
   -RunbookName <String>
   -ScheduleName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRMAutomationScheduledRunbook
   -ScheduleName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmAutomationScheduledRunbook cmdlet gets one or more Azure Automation runbooks and associated schedules. By default, this cmdlet gets all scheduled runbooks. Specify the name of a runbook or a schedule or both to see specific runbook schedules.

Examples

Example 1: Get all scheduled runbooks

PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01"

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

Example 2: Get all schedules associated with a runbook

PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -RunbookName "Runbk01"

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

Example 3: Get all runbooks associated with a schedule

PS C:\>Get-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ScheduleName "Schedule01"

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

Parameters

-AutomationAccountName

Specifies an Automation account for the runbook on which this cmdlet operates.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-JobScheduleId

Specifies the ID of a scheduled job that this cmdlet gets.

Type:	Nullable<T>[Guid]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of a resource group for scheduled runbooks that this cmdlet gets.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RunbookName

Specifies the name of a runbook for which this cmdlet gets scheduled runbooks.

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ScheduleName

Specifies the name of a schedule for which this cmdlet gets scheduled runbooks.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

Nullable<T>[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

String

Outputs

JobSchedule