Suspend-AzAutomationJob

Reference

Module:: Az.Automation

Suspends an Automation job.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

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

Description

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

Examples

Example 1: Suspend a job

PS C:\>Suspend-AzAutomationJob -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
Accept pipeline input:	True
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
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
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
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

Guid

String

Outputs

Void