< Back
Register-AzureRmAutomationScheduledRunbook
Post
NAME Register-AzureRmAutomationScheduledRunbook
SYNOPSIS
Associates a runbook to a schedule.
SYNTAX
Register-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-Parameters <IDictionary>] -RunbookName <String> [-RunOn <String>] -ScheduleName <String> [<CommonParameters>]
DESCRIPTION
The Register-AzureRmAutomationScheduledRunbook cmdlet associates an Azure Automation runbook to a schedule. The runbook starts based on the
schedule you specify using the ScheduleName parameter.
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
-Parameters <IDictionary>
Specifies a hash table of key/value pairs. The keys are runbook parameter names. The values are runbook parameter values. When the runbook
starts in response to the associated schedule, these parameters are passed to the runbook.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for the scheduled runbook.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunbookName <String>
Specifies the name of the runbook that this cmdlet associates to a schedule.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunOn <String>
The name of the hybrid runbook worker group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
Specifies the name of the schedule to which this cmdlet associates a runbook.
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: Associate a runbook with a schedule
PS C:\\>Register-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Sched01" -ResourceGroupName
"ResourceGroup01"
This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ledrunbook
Get-AzureRmAutomationScheduledRunbook
Unregister-AzureRmAutomationScheduledRunbook
SYNOPSIS
Associates a runbook to a schedule.
SYNTAX
Register-AzureRmAutomationScheduledRunbook [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-Parameters <IDictionary>] -RunbookName <String> [-RunOn <String>] -ScheduleName <String> [<CommonParameters>]
DESCRIPTION
The Register-AzureRmAutomationScheduledRunbook cmdlet associates an Azure Automation runbook to a schedule. The runbook starts based on the
schedule you specify using the ScheduleName parameter.
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
-Parameters <IDictionary>
Specifies a hash table of key/value pairs. The keys are runbook parameter names. The values are runbook parameter values. When the runbook
starts in response to the associated schedule, these parameters are passed to the runbook.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group for the scheduled runbook.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunbookName <String>
Specifies the name of the runbook that this cmdlet associates to a schedule.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RunOn <String>
The name of the hybrid runbook worker group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScheduleName <String>
Specifies the name of the schedule to which this cmdlet associates a runbook.
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: Associate a runbook with a schedule
PS C:\\>Register-AzureRmAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Sched01" -ResourceGroupName
"ResourceGroup01"
This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ledrunbook
Get-AzureRmAutomationScheduledRunbook
Unregister-AzureRmAutomationScheduledRunbook