Stop-AzureSiteRecoveryJob

  • Reference
Module:
Azure

Stops a Site Recovery 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

Stop-AzureSiteRecoveryJob
    -Job <ASRJob>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]
Stop-AzureSiteRecoveryJob
    -Id <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Stop-AzureSiteRecoveryJob cmdlet stops an Azure Site Recovery job.

Examples

Example 1: Stop all jobs

PS C:\>$Jobs = Get-AzureSiteRecoveryJob 
PS C:\> Stop-AzureSiteRecoveryJob -Job $Jobs

The first command gets the Azure Site Recovery jobs for the current Azure Site Recovery vault by using the Get-AzureSiteRecoveryJob cmdlet, and then stores the results in the $Jobs variable.

The second command stops the jobs specified by $Jobs.

Parameters

-Id

Specifies the ID of the job to stop.

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

-Job

Specifies the job to stop.

Type:ASRJob
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