Edit-AzRecoveryServicesAsrRecoveryPlan

Reference

Module:: Az.RecoveryServices

Edits a Site Recovery plan.

Note

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

Syntax

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

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

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

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

Description

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

Examples

Example 1

$RP = Edit-AzRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP -AppendGroup

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

Example 2

Edits a Site Recovery plan. (autogenerated)

Edit-AzRecoveryServicesAsrRecoveryPlan -AddProtectedItem <ASRReplicationProtectedItem[]> -Group <ASRRecoveryPlanGroup> -InputObject $RP

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
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
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
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Group

Specifies a recovery plan group.

Type:	ASRRecoveryPlanGroup
Position:	Named
Default value:	None
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-AzASRRecoveryPlan with the edited recovery plan object.)

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

Inputs

ASRRecoveryPlan

Outputs