Edit

Share via

New-AzRecoveryServicesAsrAzureToAzureReplicationProtectedItemConfig

Module:
Az.RecoveryServices Module

Creates a replication protected item mapping object for Azure virtual machine to be replicated.

Syntax

AzureToAzureWithoutDiskDetails (Default) 

New-AzRecoveryServicesAsrAzureToAzureReplicationProtectedItemConfig
    -ReplicationProtectedItemName <String>
    -RecoveryResourceGroupId <String>
    [-RecoveryAvailabilitySetId <String>]
    [-RecoveryBootDiagStorageAccountId <String>]
    [-RecoveryAvailabilityZone <String>]
    [-RecoveryProximityPlacementGroupId <String>]
    [-RecoveryVirtualMachineScaleSetId <String>]
    [-RecoveryCapacityReservationGroupId <String>]
    [-DiskEncryptionVaultId <String>]
    [-DiskEncryptionSecretUrl <String>]
    [-KeyEncryptionKeyUrl <String>]
    [-KeyEncryptionVaultId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureToAzure 

New-AzRecoveryServicesAsrAzureToAzureReplicationProtectedItemConfig
    -ReplicationProtectedItemName <String>
    -RecoveryResourceGroupId <String>
    -AzureToAzureDiskReplicationConfiguration <ASRAzuretoAzureDiskReplicationConfig[]>
    [-ManagedDisk]
    [-RecoveryAvailabilitySetId <String>]
    [-RecoveryBootDiagStorageAccountId <String>]
    [-RecoveryAvailabilityZone <String>]
    [-RecoveryProximityPlacementGroupId <String>]
    [-RecoveryVirtualMachineScaleSetId <String>]
    [-RecoveryCapacityReservationGroupId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Creates a protected item mapping object to get target properties (recovery region) to be used to replicate the protected item.

Examples

Example 1

New-AzRecoveryServicesAsrAzureToAzureReplicationProtectedItemConfig -ReplicationProtectedItemName $rpiName1 -RecoveryResourceGroupId $rgId -RecoveryAvailabilitySetId $avset -RecoveryProximityPlacementGroupId $ppg

Create a replication protected item mapping object for Azure virtual machine to be replicated without disk details. Used during Azure to Azure re-protect operation for Replication protection cluster.

Example 2

New-AzRecoveryServicesAsrAzureToAzureReplicationProtectedItemConfig -ManagedDisk -ReplicationProtectedItemName $rpiName2 -RecoveryResourceGroupId $rgId -AzureToAzureDiskReplicationConfiguration $disks -RecoveryAvailabilitySetId $avset -RecoveryProximityPlacementGroupId $ppg

Create a replication protected item mapping object for Azure virtual machine to be replicated with disk details. Used during Azure to Azure re-protect operation for Replication protection cluster.

Parameters

-AzureToAzureDiskReplicationConfiguration

Specifies disk config for the replication protected item.

Parameter properties

Type:

ASRAzuretoAzureDiskReplicationConfig[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureToAzure
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

-DiskEncryptionSecretUrl

Specifies the disk encryption secret URL(Azure disk encryption) to be used be recovery VM after failover.

Parameter properties

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

Parameter sets

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

-DiskEncryptionVaultId

Specifies the disk encryption secret key vault ID(Azure disk encryption) to be used be recovery VM after failover.

Parameter properties

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

Parameter sets

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

-KeyEncryptionKeyUrl

Specifies the disk encryption secret key URL(Azure disk encryption) to be used be recovery VM after failover.

Parameter properties

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

Parameter sets

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

-KeyEncryptionVaultId

Specifies the disk encryption secret key vault ID(Azure disk encryption) to be used be recovery VM after failover.

Parameter properties

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

Parameter sets

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

-ManagedDisk

Specifies for input with disk details

Parameter properties

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

Parameter sets

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

-RecoveryAvailabilitySetId

The availability set that the virtual machine should be created in upon failover

Parameter properties

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

Parameter sets

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

-RecoveryAvailabilityZone

The availability zone that the virtual machine should be created in upon failover

Parameter properties

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

Parameter sets

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

-RecoveryBootDiagStorageAccountId

{{ Fill RecoveryBootDiagStorageAccountId Description }}

Parameter properties

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

Parameter sets

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

-RecoveryCapacityReservationGroupId

Specifies the storage account for boot diagnostics for recovery azure VM.

Parameter properties

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

Parameter sets

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

-RecoveryProximityPlacementGroupId

Specify the capacity reservation group Id to be used by the failover VM in target recovery region.

Parameter properties

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

Parameter sets

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

-RecoveryResourceGroupId

Recovery resourceGroup id for protected Vm.

Parameter properties

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

Parameter sets

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

-RecoveryVirtualMachineScaleSetId

Specifies the recovery virtual machine scale set id.

Parameter properties

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

Parameter sets

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

-ReplicationProtectedItemName

Specifies the replication protected item name.

Parameter properties

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

Parameter sets

(All)
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

None

Outputs

ASRAzureToAzureReplicationProtectedItemConfig