Edit

Share via

Edit-AzRecoveryServicesAsrRecoveryPlan

Module:
Az.RecoveryServices Module

Edits a Site Recovery plan.

Syntax

AppendGroup (Default) 

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

RemoveGroup 

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

AddReplicationProtectedItems 

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

RemoveReplicationProtectedItems 

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.

Parameter properties

Type:

ASRReplicationProtectedItem[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddProtectedItems

Parameter sets

AddReplicationProtectedItems
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AppendGroup

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AppendGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Group

Specifies a recovery plan group.

Parameter properties

Type:ASRRecoveryPlanGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AddReplicationProtectedItems
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
RemoveReplicationProtectedItems
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.)

Parameter properties

Type:ASRRecoveryPlan
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RecoveryPlan

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveGroup

Removes the specified group from the recovery plan object.

Parameter properties

Type:ASRRecoveryPlanGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

RemoveGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveProtectedItem

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

Parameter properties

Type:

ASRReplicationProtectedItem[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveProtectedItems

Parameter sets

RemoveReplicationProtectedItems
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

ASRRecoveryPlan

Outputs

ASRRecoveryPlan