Unregister-AzAutomationScheduledRunbook

  • Reference
Module:
Az.Automation

Removes an association between a runbook and a schedule.

Syntax

Unregister-AzAutomationScheduledRunbook
          -JobScheduleId <Guid>
          [-Force]
          [-ResourceGroupName] <String>
          [-AutomationAccountName] <String>
          [-DefaultProfile <IAzureContextContainer>]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-AzAutomationScheduledRunbook
          -RunbookName <String>
          -ScheduleName <String>
          [-Force]
          [-ResourceGroupName] <String>
          [-AutomationAccountName] <String>
          [-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.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ps_force

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:Nullable<T>[Guid]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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 dissociates from a schedule.

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

-ScheduleName

Specifies the name of the schedule from which this cmdlet dissociates a runbook.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Nullable<T>[[System.Guid, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String

Outputs

Void