Edit

Share via


New-AzRecoveryServicesAsrRecoveryPlan

Creates an ASR recovery plan.

Syntax

EnterpriseToEnterprise (Default)

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -RecoveryFabric <ASRFabric>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EnterpriseToAzure

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -FailoverDeploymentModel <String>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-Azure]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureZoneToZone

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-PrimaryZone <String>]
    [-RecoveryZone <String>]
    [-PrimaryEdgeZone <String>]
    [-RecoveryEdgeZone <String>]
    [-AzureZoneToZone]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EdgeZoneToAzure

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -PrimaryEdgeZone <String>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-EdgeZoneToAzure]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureToEdgeZone

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -RecoveryEdgeZone <String>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-AzureToEdgeZone]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EdgeZoneToEdgeZone

New-AzRecoveryServicesAsrRecoveryPlan
    -Name <String>
    -PrimaryFabric <ASRFabric>
    -PrimaryEdgeZone <String>
    -RecoveryEdgeZone <String>
    -ReplicationProtectedItem <ASRReplicationProtectedItem[]>
    [-EdgeZoneToEdgeZone]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByRPFile

New-AzRecoveryServicesAsrRecoveryPlan
    -Path <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-AzRecoveryServicesAsrRecoveryPlan cmdlet creates an Azure Site Recovery, recovery plan in the Recovery Services vault.

A recovery plan gathers virtual machines belonging to an application into a unit to allow them to be recovered together.

Examples

Example 1

$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -RecoveryFabric $RecoveryFabric -ReplicationProtectedItem $RPI

Starts the recovery plan creation operation with the specified parameters and returns the ASR job used to track the operation.

Example 2

$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -PrimaryZone $pZone -RecoveryZone $rZone -ReplicationProtectedItem $RPI

Starts the recovery plan creation operation for Azure zone to zone replicated items and returns the ASR job used to track the operation.

Example 3

$currentJob = New-AzRecoveryServicesAsrRecoveryPlan -Name $RPName -PrimaryFabric $PrimaryFabric -PrimaryEdgeZone $pEdgeZone -RecoveryZone $rZone -ReplicationProtectedItem $RPI

Starts the recovery plan creation operation for Azure EdgeZone to Availability Zone replicated items and returns the ASR job used to track the operation.

Parameters

-Azure

Switch parameter specifies the scenario for azure to azure disaster recovery, recovery plan creation.

Parameter properties

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

Parameter sets

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

-AzureToEdgeZone

Switch parameter specifies creating the replicated item in Azure to EdgeZone scenario.

Parameter properties

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

Parameter sets

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

-AzureZoneToZone

Switch parameter specifies creating the replicated item in azure zone to zone scenario.

Parameter properties

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

Parameter sets

AzureZoneToZone
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

-EdgeZoneToAzure

Switch parameter specifies creating the replicated item in EdgeZone to Azure scenario.

Parameter properties

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

Parameter sets

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

-EdgeZoneToEdgeZone

Switch parameter specifies creating the replicated item EdgeZone to EdgeZone scenario.

Parameter properties

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

Parameter sets

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

-FailoverDeploymentModel

Specifies the failover deployment model (Classic or Resource Manager) of the replication protected items that will be part of this recovery plan.

Parameter properties

Type:String
Default value:None
Accepted values:Classic, ResourceManager
Supports wildcards:False
DontShow:False

Parameter sets

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

-Name

Name of the recovery plan.

Parameter properties

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

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EnterpriseToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureZoneToZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EdgeZoneToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToEdgeZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EdgeZoneToEdgeZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

Specifies the path to the recovery plan definition json file. A recovery plan definition json can be used to create the recovery plan.

Parameter properties

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

Parameter sets

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

-PrimaryEdgeZone

Specifies the primary edge zone of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

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

-PrimaryFabric

Specifies the ASR fabric object for the primary ASR fabric of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EnterpriseToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureZoneToZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EdgeZoneToAzure
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToEdgeZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
EdgeZoneToEdgeZone
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrimaryZone

Specifies the primary Availability zone of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

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

-RecoveryEdgeZone

Specifies the recovery edge zone of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

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

-RecoveryFabric

Specifies the ASR fabric object for the recovery ASR fabric of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

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

-RecoveryZone

Specifies the primary Availability zone of the replication protected items that will be part of this recovery plan.

Parameter properties

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

Parameter sets

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

-ReplicationProtectedItem

The list of replication protected items to add to the first group of the recovery plan.

Parameter properties

Type:

ASRReplicationProtectedItem[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnterpriseToEnterprise
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
EnterpriseToAzure
Position:Named
Mandatory:True
Value from pipeline:True
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

ASRReplicationProtectedItem

Outputs

ASRJob