Edit

Get-AzRecoveryServicesAsrJob

  • Reference
Module:
Az.RecoveryServices

Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault.

Syntax

Get-AzRecoveryServicesAsrJob
   [-StartTime <DateTime>]
   [-EndTime <DateTime>]
   [-TargetObjectId <String>]
   [-State <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesAsrJob
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesAsrJob
   -Job <ASRJob>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzRecoveryServicesAsrJob cmdlet gets Azure Site Recovery jobs. You can use this cmdlet to view the ASR jobs in the Recovery Services vault.

Examples

Example 1

$jobs = Get-AzRecoveryServicesAsrJob -TargetObjectId $ASRObjectId

Returns all the jobs on a particular ASR object(reference the ASR object such as replicated item or recovery plan by its ID.)

Example 2

Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault. (autogenerated)

Get-AzRecoveryServicesAsrJob -Job $Job

Parameters

-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

-EndTime

Specifies the end time for the jobs. This cmdlet gets all jobs that started before the specified time. To obtain a DateTime object for this parameter, use the Get-Date cmdlet. For more information, type Get-Help Get-Date.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Job

Specifies the ASR job object to get updated details for.

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

-Name

Specify the ASR job by name.

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

-StartTime

Specifies the start time for the jobs. This cmdlet gets all jobs that started after the specified time.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-State

Specifies the state for a ASR job. This cmdlet gets all jobs that match the specified state. The acceptable values for this parameter are:

  • NotStarted
  • InProgress
  • Succeeded
  • Other
  • Failed
  • Cancelled
  • Suspended
Type:String
Accepted values:NotStarted, InProgress, Succeeded, Other, Failed, Cancelled, Suspended
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetObjectId

Specifies the ID of the object. Used to search for jobs on the specified object.

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

Inputs

ASRJob

Outputs

ASRJob