Get-AzureAutomationScheduledRunbook
Gets Azure Automation runbooks and associated schedules.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
ByAll (Default)
Get-AzureAutomationScheduledRunbook
-AutomationAccountName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByJobScheduleId
Get-AzureAutomationScheduledRunbook
-JobScheduleId <Guid>
-AutomationAccountName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByRunbookName
Get-AzureAutomationScheduledRunbook
-RunbookName <String>
-AutomationAccountName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByRunbookNameAndScheduleName
Get-AzureAutomationScheduledRunbook
-RunbookName <String>
-ScheduleName <String>
-AutomationAccountName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByScheduleName
Get-AzureAutomationScheduledRunbook
-ScheduleName <String>
-AutomationAccountName <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
Important
This PowerShell command for Azure Automation is longer supported as of 01/23/2020. The Azure Service Management model is deprecated for Azure Automation and was disabled on that date. Please use the commands which support the Azure Resource Management model in Az.Automation.
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.
Parameters
-AutomationAccountName
Specifies the name of an Azure Automation account.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-JobScheduleId
Specifies the ID of a scheduled job.
Parameter properties
| Type: | 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 |
-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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RunbookName
Specifies the name of a runbook.
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.
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.