Suspend-AzureAutomationJob

Suspends an Automation job.

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

Suspend-AzureAutomationJob
       -Id <Guid>
       -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 Suspend-AzureAutomationJob cmdlet suspends a Microsoft Azure Automation job. Specify a running Automation job.

To resume a suspended job, use the Resume-AzureAutomationJob cmdlet.

Examples

Example 1: Suspend a job

PS C:\> Suspend-AzureAutomationJob -AutomationAccountName "Contoso17" -Id 2989b069-24fe-40b9-b3bd-cb7e5eac4b64

This command suspends the job that has the specified ID.

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

-Id

Specifies the ID of a job.

Type:Guid
Aliases:JobId
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