Unregister-AzAutomationScheduledRunbook
Removes an association between a runbook and a schedule.
Syntax
ByJobScheduleId (Default)
Unregister-AzAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-JobScheduleId <Guid>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByRunbookNameAndScheduleName
Unregister-AzAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-RunbookName <String>
-ScheduleName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Unregister-AzAutomationScheduledRunbook cmdlet removes the association between an Azure Automation runbook and a schedule.
The schedule no longer starts the runbook.
Examples
Example 1: Remove the association between a runbook and a schedule
Unregister-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01" -ResourceGroupName "ResourceGroup01" -ScheduleName "Runbk01Sched"
This command removes the association between the runbook named Runbk01 and the schedule named Runbk01Sched.
Parameters
-AutomationAccountName
Specifies an Automation account for the runbook on which this cmdlet operates.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Force
ps_force
Parameter properties
Type: SwitchParameter
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
-JobScheduleId
Specifies the ID of a scheduled runbook.
Parameter properties
Type: Nullable<T> [ 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
-ResourceGroupName
Specifies the name of a resource group for the scheduled runbook.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RunbookName
Specifies the name of the runbook that this cmdlet dissociates from a schedule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
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 the schedule from which this cmdlet dissociates a runbook.
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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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 .
Outputs
