Upravit

Sdílet prostřednictvím

Get-AzAutomationScheduledRunbook

  • Reference
Module:
Az.Automation

Gets Automation runbooks and associated schedules.

Syntax

Get-AzAutomationScheduledRunbook
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationScheduledRunbook
   -JobScheduleId <Guid>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationScheduledRunbook
   -RunbookName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationScheduledRunbook
   -RunbookName <String>
   -ScheduleName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationScheduledRunbook
   -ScheduleName <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <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.

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:AzContext, 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, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String

Outputs

JobSchedule