Get-AzureRmRecoveryServicesAsrRecoveryPlan

Reference

Module:: AzureRM.RecoveryServices.SiteRecovery

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

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmRecoveryServicesAsrRecoveryPlan
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

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

Description

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

Examples

Example 1

PS C:\> $RP = Get-AzureRmRecoveryServicesAsrRecoveryPlan -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:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
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
Required:	True
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
Required:	True
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-AzureRmRecoveryServicesASRRecoveryPlan cmdlet

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

Inputs

None

Outputs

IEnumerable<T>[[Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan, Microsoft.Azure.Commands.RecoveryServices.SiteRecovery, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]]