Microsoft.RecoveryServices vaults/replicationPolicies 2021-08-01

Article
12/09/2024

Bicep resource definition

The vaults/replicationPolicies resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/replicationPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationPolicies@2021-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    providerSpecificInput: {
      instanceType: 'string'
      // For remaining properties, see PolicyProviderSpecificInput objects
    }
  }
}

PolicyProviderSpecificInput objects

Set the instanceType property to specify the type of object.

For A2A, use:

{
  appConsistentFrequencyInMinutes: int
  crashConsistentFrequencyInMinutes: int
  instanceType: 'A2A'
  multiVmSyncStatus: 'string'
  recoveryPointHistory: int
}

For A2ACrossClusterMigration, use:

{
  instanceType: 'A2ACrossClusterMigration'
}

For HyperVReplica2012R2, use:

{
  allowedAuthenticationType: int
  applicationConsistentSnapshotFrequencyInHours: int
  compression: 'string'
  initialReplicationMethod: 'string'
  instanceType: 'HyperVReplica2012R2'
  offlineReplicationExportPath: 'string'
  offlineReplicationImportPath: 'string'
  onlineReplicationStartTime: 'string'
  recoveryPoints: int
  replicaDeletion: 'string'
  replicationFrequencyInSeconds: int
  replicationPort: int
}

For HyperVReplicaAzure, use:

{
  applicationConsistentSnapshotFrequencyInHours: int
  instanceType: 'HyperVReplicaAzure'
  onlineReplicationStartTime: 'string'
  recoveryPointHistoryDuration: int
  replicationInterval: int
  storageAccounts: [
    'string'
  ]
}

For InMage, use:

{
  appConsistentFrequencyInMinutes: int
  instanceType: 'InMage'
  multiVmSyncStatus: 'string'
  recoveryPointHistory: int
  recoveryPointThresholdInMinutes: int
}

For InMageAzureV2, use:

{
  appConsistentFrequencyInMinutes: int
  crashConsistentFrequencyInMinutes: int
  instanceType: 'InMageAzureV2'
  multiVmSyncStatus: 'string'
  recoveryPointHistory: int
  recoveryPointThresholdInMinutes: int
}

For InMageRcm, use:

{
  appConsistentFrequencyInMinutes: int
  crashConsistentFrequencyInMinutes: int
  enableMultiVmSync: 'string'
  instanceType: 'InMageRcm'
  recoveryPointHistoryInMinutes: int
}

For InMageRcmFailback, use:

{
  appConsistentFrequencyInMinutes: int
  crashConsistentFrequencyInMinutes: int
  instanceType: 'InMageRcmFailback'
}

For VMwareCbt, use:

{
  appConsistentFrequencyInMinutes: int
  crashConsistentFrequencyInMinutes: int
  instanceType: 'VMwareCbt'
  recoveryPointHistoryInMinutes: int
}

Property values

A2ACrossClusterMigrationPolicyCreationInput

Name	Description	Value
instanceType	The class type.	'A2ACrossClusterMigration' (required)

A2APolicyCreationInput

Name	Description	Value
appConsistentFrequencyInMinutes	The app consistent snapshot frequency (in minutes).	int
crashConsistentFrequencyInMinutes	The crash consistent snapshot frequency (in minutes).	int
instanceType	The class type.	'A2A' (required)
multiVmSyncStatus	A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.	'Disable' 'Enable' (required)
recoveryPointHistory	The duration in minutes until which the recovery points need to be stored.	int

CreatePolicyInputPropertiesOrPolicyProperties

Name	Description	Value
providerSpecificInput	The ReplicationProviderSettings.	PolicyProviderSpecificInput

HyperVReplicaAzurePolicyInput

Name	Description	Value
applicationConsistentSnapshotFrequencyInHours	The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.	int
instanceType	The class type.	'HyperVReplicaAzure' (required)
onlineReplicationStartTime	The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.	string
recoveryPointHistoryDuration	The duration (in hours) to which point the recovery history needs to be maintained.	int
replicationInterval	The replication interval.	int
storageAccounts	The list of storage accounts to which the VMs in the primary cloud can replicate to.	string[]

HyperVReplicaBluePolicyInput

Name	Description	Value
allowedAuthenticationType	A value indicating the authentication type.	int
applicationConsistentSnapshotFrequencyInHours	A value indicating the application consistent frequency.	int
compression	A value indicating whether compression has to be enabled.	string
initialReplicationMethod	A value indicating whether IR is online.	string
instanceType	The class type.	'HyperVReplica2012R2' (required)
offlineReplicationExportPath	A value indicating the offline IR export path.	string
offlineReplicationImportPath	A value indicating the offline IR import path.	string
onlineReplicationStartTime	A value indicating the online IR start time.	string
recoveryPoints	A value indicating the number of recovery points.	int
replicaDeletion	A value indicating whether the VM has to be auto deleted.	string
replicationFrequencyInSeconds	A value indicating the replication interval.	int
replicationPort	A value indicating the recovery HTTPS port.	int

InMageAzureV2PolicyInput

Name	Description	Value
appConsistentFrequencyInMinutes	The app consistent snapshot frequency (in minutes).	int
crashConsistentFrequencyInMinutes	The crash consistent snapshot frequency (in minutes).	int
instanceType	The class type.	'InMageAzureV2' (required)
multiVmSyncStatus	A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.	'Disable' 'Enable' (required)
recoveryPointHistory	The duration in minutes until which the recovery points need to be stored.	int
recoveryPointThresholdInMinutes	The recovery point threshold in minutes.	int

InMagePolicyInput

Name	Description	Value
appConsistentFrequencyInMinutes	The app consistent snapshot frequency (in minutes).	int
instanceType	The class type.	'InMage' (required)
multiVmSyncStatus	A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.	'Disable' 'Enable' (required)
recoveryPointHistory	The duration in minutes until which the recovery points need to be stored.	int
recoveryPointThresholdInMinutes	The recovery point threshold in minutes.	int

InMageRcmFailbackPolicyCreationInput

Name	Description	Value
appConsistentFrequencyInMinutes	The app consistent snapshot frequency (in minutes).	int
crashConsistentFrequencyInMinutes	The crash consistent snapshot frequency (in minutes).	int
instanceType	The class type.	'InMageRcmFailback' (required)

InMageRcmPolicyCreationInput

Name	Description	Value
appConsistentFrequencyInMinutes	The app consistent snapshot frequency (in minutes).	int
crashConsistentFrequencyInMinutes	The crash consistent snapshot frequency (in minutes).	int
enableMultiVmSync	A value indicating whether multi-VM sync has to be enabled.	string
instanceType	The class type.	'InMageRcm' (required)
recoveryPointHistoryInMinutes	The duration in minutes until which the recovery points need to be stored.	int