Edit

Share via


Update-AzRecoveryServicesAsrPolicy

Updates an Azure Site Recovery replication policy.

Syntax

Default (Default)

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-ReplicationMethod <String>]
    [-ReplicationFrequencyInSeconds <String>]
    [-NumberOfRecoveryPointsToRetain <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-Compression <String>]
    [-ReplicationPort <UInt16>]
    [-Authentication <String>]
    [-ReplicationStartTime <TimeSpan>]
    [-ReplicaDeletion <String>]
    [-RecoveryAzureStorageAccountId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

VMwareToAzure

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-VMwareToAzure]
    [-RecoveryPointRetentionInHours <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-MultiVmSyncStatus <String>]
    [-RPOWarningThresholdInMinutes <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureToAzure

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-AzureToAzure]
    [-RecoveryPointRetentionInHours <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-MultiVmSyncStatus <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureToVMware

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-AzureToVMware]
    [-RecoveryPointRetentionInHours <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-MultiVmSyncStatus <String>]
    [-RPOWarningThresholdInMinutes <Int32>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HyperVToAzure

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-HyperVToAzure]
    [-ReplicationFrequencyInSeconds <String>]
    [-NumberOfRecoveryPointsToRetain <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-ReplicationStartTime <TimeSpan>]
    [-RecoveryAzureStorageAccountId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

EnterpriseToEnterprise

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-VmmToVmm]
    [-ReplicationMethod <String>]
    [-ReplicationFrequencyInSeconds <String>]
    [-NumberOfRecoveryPointsToRetain <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-Compression <String>]
    [-ReplicationPort <UInt16>]
    [-Authentication <String>]
    [-ReplicationStartTime <TimeSpan>]
    [-ReplicaDeletion <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ReplicateVMwareToAzure

Update-AzRecoveryServicesAsrPolicy
    -InputObject <ASRPolicy>
    [-ReplicateVMwareToAzure]
    [-RecoveryPointRetentionInHours <Int32>]
    [-ApplicationConsistentSnapshotFrequencyInHours <Int32>]
    [-MultiVmSyncStatus <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzRecoveryServicesAsrPolicy cmdlet updates the specified Azure Site Recovery replication policy.

Examples

Example 1

$currentJob = Update-AzRecoveryServicesAsrPolicy -Policy $Policy -ReplicationFrequencyInSeconds 900

Starts the update replication policy operation using the specified parameters and returns the ASR job used to track the operation.

Example 2

$currentJob = Update-AzRecoveryServicesAsrPolicy -AzureToAzure -InputObject $Policy -RecoveryPointRetentionInHours 20

Starts the update azure to azure replication policy using the specified parameters and returns the ASR job used to track the operation.

Parameters

-ApplicationConsistentSnapshotFrequencyInHours

Specifies the frequency(in hours) at which to create application consistent recovery points.

Parameter properties

Type:Int32
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

-Authentication

Specifies the type of authentication used.

Parameter properties

Type:String
Default value:None
Accepted values:Certificate, Kerberos
Supports wildcards:False
DontShow:False

Parameter sets

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

-AzureToAzure

Specifies the Azure to Azure disaster recovery.

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

-AzureToVMware

Specifies the Azure to vMWare disaster recovery.

Parameter properties

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

Parameter sets

AzureToVMware
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Compression

Specifies if compression should be enabled.

Parameter properties

Type:String
Default value:None
Accepted values:Enable, Disable
Supports wildcards:False
DontShow:False

Parameter sets

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

-HyperVToAzure

Switch parameter indicating that the specified policy is used to replicate Hyper-V virtual machines to Azure.

Parameter properties

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

Parameter sets

HyperVToAzure
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Input object for the cmdlet: Specifies the ASR replication policy object corresponding to the replication policy to be updated.

Parameter properties

Type:ASRPolicy
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Policy

Parameter sets

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

-MultiVmSyncStatus

Specifies multiVm sync status for the policy.

Parameter properties

Type:String
Default value:None
Accepted values:Enable, Disable
Supports wildcards:False
DontShow:False

Parameter sets

VMwareToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToVMware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ReplicateVMwareToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NumberOfRecoveryPointsToRetain

Specifies the number recovery points to retain.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RecoveryPoints

Parameter sets

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

-RecoveryAzureStorageAccountId

Specifies the Azure storage account ID of the replication target. Used as the target storage account for replication if an alternate is not provided while enabling replication using the New-AzRecoveryServicesASRReplicationProtectedItem cmdlet.

Parameter properties

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

Parameter sets

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

-RecoveryPointRetentionInHours

Time in hours to retain recovery points after creation.

Parameter properties

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

Parameter sets

VMwareToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureToVMware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ReplicateVMwareToAzure
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicaDeletion

Specifies if the replica virtual machine should be deleted on disabling replication from a VMM managed site to another.

Parameter properties

Type:String
Default value:None
Accepted values:Required, NotRequired
Supports wildcards:False
DontShow:False

Parameter sets

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

-ReplicateVMwareToAzure

Switch parameter specifying VMware to Azure replication scenario.

Parameter properties

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

Parameter sets

ReplicateVMwareToAzure
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReplicationFrequencyInSeconds

Specifies the replication frequency interval in seconds. Valid values are:

  • 30
  • 300
  • 900

Parameter properties

Type:String
Default value:None
Accepted values:30, 300, 900
Supports wildcards:False
DontShow:False

Parameter sets

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

-ReplicationMethod

Specifies the replication method.

Parameter properties

Type:String
Default value:None
Accepted values:Online, Offline
Supports wildcards:False
DontShow:False

Parameter sets

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

-ReplicationPort

Specifies the port used for replication.

Parameter properties

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

Parameter sets

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

-ReplicationStartTime

Specifies the replication start time. It must be no later than 24-hours from the start of the job.

Parameter properties

Type:

Nullable<T>[TimeSpan]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-RPOWarningThresholdInMinutes

The RPO threshold value in minutes to warn on.

Parameter properties

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

Parameter sets

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

-VmmToVmm

Switch parameter indicating that the specified policy is used to replicate VMM managed Hyper-V virtual machines between two Hyper-V sites.

Parameter properties

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

Parameter sets

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

-VMwareToAzure

Switch parameter indicating that the specified policy is used to replicate VMware virtual machines to Azure.

Parameter properties

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

Parameter sets

VMwareToAzure
Position:0
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

ASRPolicy

Outputs

ASRJob