Edit

Share via

Unregister-AzureAutomationScheduledRunbook

  • Reference
Module:
Azure

Removes an association between a runbook and a schedule.

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

Unregister-AzureAutomationScheduledRunbook
          -JobScheduleId <Guid>
          [-Force]
          -AutomationAccountName <String>
          [-Profile <AzureSMProfile>]
          [<CommonParameters>]
Unregister-AzureAutomationScheduledRunbook
          -RunbookName <String>
          -ScheduleName <String>
          [-Force]
          -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 Unregister-AzureAutomationScheduledRunbook cmdlet removes the association between a Microsoft Azure Automation runbook and a schedule, which stops the runbook from starting when the schedule fires.

Examples

Example 1: Remove the association between a runbook and a schedule

PS C:\> Unregister-AzureAutomationScheduledRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ScheduleName "Runbk01Sched"

This command removes the association between the runbook named Runbk01 and the schedule named Runbk01Sched.

Parameters

-AutomationAccountName

Specifies the name of an Automation account.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobScheduleId

Specifies the ID of a scheduled runbook.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunbookName

Specifies the name of a runbook.

Type:String
Aliases:Name
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ScheduleName

Specifies the name of a schedule.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False