Get-AzAutomationScheduledRunbook

Module:

Az.Automation Module

Gets Automation runbooks and associated schedules.

Syntax

ByAll (Default)

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

ByJobScheduleId

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

ByRunbookName

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

ByRunbookNameAndScheduleName

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

ByScheduleName

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

Description

The Get-AzAutomationScheduledRunbook 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

Get-AzAutomationScheduledRunbook -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

Get-AzAutomationScheduledRunbook -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

Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -ScheduleName "Schedule01"

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

Example 4: Get Parameters given to a particular Scheduled Runbook

Get-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -ResourceGroupName "ResourceGroup01" -JobScheduleId "2b1d7738-093d-4ff7-b87b-e4b2321319e5"

This is currently not supported for jobs created with complex parameters (for example - array) through Azure portal.

Parameters

-AutomationAccountName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-JobScheduleId

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

Parameter properties

Type:	Nullable<T>[Guid]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByJobScheduleId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceGroupName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-RunbookName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Name

Parameter sets

ByRunbookName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByRunbookNameAndScheduleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ScheduleName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByRunbookNameAndScheduleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

ByScheduleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Nullable<T>

String

Outputs

JobSchedule

Related Links

• Register-AzAutomationScheduledRunbook
• Unregister-AzAutomationScheduledRunbook