Edit

Share via

Suspend-AzureRMAutomationJob

  • Reference
Module:
AzureRM.Automation

Suspends an Automation job.

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

Suspend-AzureRMAutomationJob
       [-Id] <Guid>
       [-ResourceGroupName] <String>
       [-AutomationAccountName] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

Description

The Suspend-AzureRmAutomationJob cmdlet suspends an Azure Automation job. Specify a running Automation job. To resume a suspended job, use the Resume-AzureRmAutomationJob cmdlet.

Examples

Example 1: Suspend a job

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

This command suspends the job that has the specified ID.

Parameters

-AutomationAccountName

Specifies the name of an Automation account in which this cmdlet suspends a job.

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

-Id

Specifies the ID of a job that this cmdlet suspends.

Type:Guid
Aliases:JobId
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the ID of a job that this cmdlet suspends.

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

Inputs

Guid

String

Outputs

Void