Register-AzureRMAutomationScheduledRunbook
Associates a runbook to a schedule.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Register-AzureRMAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Register-AzureRMAutomationScheduledRunbook
-RunbookName <String>
-ScheduleName <String>
[-Parameters <IDictionary>]
[-RunOn <String>]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<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.
Examples
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.
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: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameters
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.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group for the scheduled runbook.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RunbookName
Specifies the name of the runbook that this cmdlet associates to a schedule.
Type: | String |
Aliases: | Name |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RunOn
The name of the hybrid runbook worker group.
Type: | String |
Aliases: | HybridWorker |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ScheduleName
Specifies the name of the schedule to which this cmdlet associates a runbook.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |