Stop-AzureSiteRecoveryJob
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
ByObject (Default)
Stop-AzureSiteRecoveryJob
-Job <ASRJob>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ById
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Job
Specifies the job to stop.
Parameter properties
| Type: | ASRJob |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.