Stop-AzRecoveryServicesAsrJob

  • Reference
Module:
Az.RecoveryServices

Stops an Azure Site Recovery job.

Syntax

Stop-AzRecoveryServicesAsrJob
    -InputObject <ASRJob>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzRecoveryServicesAsrJob
    -Name <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzRecoveryServicesAsrJob cmdlet stops the specified Azure Site Recovery job.

Examples

Example 1

$currentJob = Stop-AzRecoveryServicesAsrJob -Job $Job

Attempts to stop the specified job and returns an updated ASR job object.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Input Object: Specify the ASR job object corresponding to the ASR job to be stopped

Type:ASRJob
Aliases:Job
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specify the ASR Job to be stopped by the ASR job name.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ASRJob

Outputs

ASRJob