Edit

Get-AzRecoveryServicesAsrRecoveryPlan

  • Reference
Module:
Az.RecoveryServices

Gets a recovery plan or all the recovery plans in the Recovery Services vault

Note

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

Syntax

Get-AzRecoveryServicesAsrRecoveryPlan
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesAsrRecoveryPlan
   -Name <String>
   [[-Path] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzRecoveryServicesAsrRecoveryPlan
   -FriendlyName <String>
   [[-Path] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzRecoveryServicesAsrRecoveryPlan cmdlet gets the details of the specified recovery plan or all recovery plans in the Recovery Services vault.

Examples

Example 1

$RP = Get-AzRecoveryServicesAsrRecoveryPlan -Name $RPName

Gets the recovery plan with the specified name.

Parameters

-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
-FriendlyName

Specifies the friendly name of the recovery plan to get.

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

Specifies the name of the recovery plan to get.

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

Specifies the file path to which this cmdlet saves the recovery plan json definition. The json definition can be edited to modify the recovery plan and used to update the recovery plan through the Update-AzRecoveryServicesASRRecoveryPlan cmdlet

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

Inputs

None

Outputs

ASRRecoveryPlan