< Back
Get-AzureRmAutomationScheduledRunbook
Post
NAME Get-AzureRmAutomationScheduledRunbook
SYNOPSIS
Gets Automation runbooks and associated schedules.
SYNTAX
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-JobScheduleId <Guid> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-RunbookName <String> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-RunbookName <String> -ScheduleName <String> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-ScheduleName <String> [<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.
PARAMETERS
-AutomationAccountName <String>
Specifies an Automation account for the runbook on which this cmdlet operates.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobScheduleId <Guid>
Specifies the ID of a scheduled job that this cmdlet gets.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for scheduled runbooks that this cmdlet gets.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunbookName <String>
Specifies the name of a runbook for which this cmdlet gets scheduled runbooks.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
Specifies the name of a schedule for which this cmdlet gets scheduled runbooks.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Automation.Model.JobSchedule
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ledrunbook
Register-AzureRmAutomationScheduledRunbook
Unregister-AzureRmAutomationScheduledRunbook
SYNOPSIS
Gets Automation runbooks and associated schedules.
SYNTAX
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-JobScheduleId <Guid> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-RunbookName <String> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-RunbookName <String> -ScheduleName <String> [<CommonParameters>]
Get-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile <IAzureContextContainer>]
-ScheduleName <String> [<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.
PARAMETERS
-AutomationAccountName <String>
Specifies an Automation account for the runbook on which this cmdlet operates.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobScheduleId <Guid>
Specifies the ID of a scheduled job that this cmdlet gets.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for scheduled runbooks that this cmdlet gets.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunbookName <String>
Specifies the name of a runbook for which this cmdlet gets scheduled runbooks.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
Specifies the name of a schedule for which this cmdlet gets scheduled runbooks.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Automation.Model.JobSchedule
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ledrunbook
Register-AzureRmAutomationScheduledRunbook
Unregister-AzureRmAutomationScheduledRunbook