Edit-AzureRmRecoveryServicesAsrRecoveryPlan

Reference

Module:: AzureRM.RecoveryServices.SiteRecovery

Edits a Site Recovery plan.

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

Edit-AzureRmRecoveryServicesAsrRecoveryPlan
    -InputObject <ASRRecoveryPlan>
    [-AppendGroup]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Edit-AzureRmRecoveryServicesAsrRecoveryPlan
    -InputObject <ASRRecoveryPlan>
    -RemoveGroup <ASRRecoveryPlanGroup>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Edit-AzureRmRecoveryServicesAsrRecoveryPlan
    -InputObject <ASRRecoveryPlan>
    -Group <ASRRecoveryPlanGroup>
    -AddProtectedItem <ASRReplicationProtectedItem[]>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Edit-AzureRmRecoveryServicesAsrRecoveryPlan
    -InputObject <ASRRecoveryPlan>
    -Group <ASRRecoveryPlanGroup>
    -RemoveProtectedItem <ASRReplicationProtectedItem[]>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Edit-AzureRmRecoveryServicesAsrRecoveryPlan cmdlet edits an Azure Site Recovery plan.

Examples

Example 1

PS C:\> $RP = Edit-AzureRmRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -AppendGroup

Appends a group to existing Azure Site Recovery recovery plan and returns the in-memory updated recovery plan.

Parameters

-AddProtectedItem

List of ASR replication protected items to be added to the recovery plan group in the recovery plan object.

Type:	ASRReplicationProtectedItem[]
Aliases:	AddProtectedItems
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AppendGroup

Switch parameter to append a recovery plan group to the recovery plan object.

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

-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:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Group

Specifies a recovery plan group.

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

-InputObject

The ASR recovery plan object to be edited (In memory operation. To update the recovery plan run Update-AzureRmASRRecoveryPlan with the edited recovery plan object.)

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

-RemoveGroup

Removes the specified group from the recovery plan object.

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

-RemoveProtectedItem

List of ASR replication protected items to be removed from the recovery plan group in the recovery plan object.

Type:	ASRReplicationProtectedItem[]
Aliases:	RemoveProtectedItems
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

ASRRecoveryPlan

Outputs

Object