Microsoft.RecoveryServices vaults/replicationRecoveryPlans 2018-01-10

The vaults/replicationRecoveryPlans resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2018-01-10' = {
  name: 'string'
  properties: {
    failoverDeploymentModel: 'string'
    groups: [
      {
        endGroupActions: [
          {
            actionName: 'string'
            customDetails: {
              instanceType: 'string'
              // For remaining properties, see RecoveryPlanActionDetails objects
            }
            failoverDirections: [ 'string' ]
            failoverTypes: [ 'string' ]
          }
        ]
        groupType: 'string'
        replicationProtectedItems: [
          {
            id: 'string'
            virtualMachineId: 'string'
          }
        ]
        startGroupActions: [
          {
            actionName: 'string'
            customDetails: {
              instanceType: 'string'
              // For remaining properties, see RecoveryPlanActionDetails objects
            }
            failoverDirections: [ 'string' ]
            failoverTypes: [ 'string' ]
          }
        ]
      }
    ]
    primaryFabricId: 'string'
    recoveryFabricId: 'string'
  }
}

RecoveryPlanActionDetails objects

Set the instanceType property to specify the type of object.

For AutomationRunbookActionDetails, use:

  instanceType: 'AutomationRunbookActionDetails'
  fabricLocation: 'string'
  runbookId: 'string'
  timeout: 'string'

For ManualActionDetails, use:

  instanceType: 'ManualActionDetails'
  description: 'string'

For ScriptActionDetails, use:

  instanceType: 'ScriptActionDetails'
  fabricLocation: 'string'
  path: 'string'
  timeout: 'string'

Property values

vaults/replicationRecoveryPlans

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-01-10'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Recovery plan creation properties. CreateRecoveryPlanInputProperties (required)

CreateRecoveryPlanInputProperties

Name Description Value
failoverDeploymentModel The failover deployment model. 'Classic'
'NotApplicable'
'ResourceManager'
groups The recovery plan groups. RecoveryPlanGroup[] (required)
primaryFabricId The primary fabric Id. string (required)
recoveryFabricId The recovery fabric Id. string (required)

RecoveryPlanGroup

Name Description Value
endGroupActions The end group actions. RecoveryPlanAction[]
groupType The group type. 'Boot'
'Failover'
'Shutdown'
replicationProtectedItems The list of protected items. RecoveryPlanProtectedItem[]
startGroupActions The start group actions. RecoveryPlanAction[]

RecoveryPlanAction

Name Description Value
actionName The action name. string (required)
customDetails Recovery plan action custom details. RecoveryPlanActionDetails (required)
failoverDirections The list of failover directions. String array containing any of:
'PrimaryToRecovery'
'RecoveryToPrimary'
failoverTypes The list of failover types. String array containing any of:
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover'

RecoveryPlanActionDetails

Name Description Value
instanceType Set the object type AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails

RecoveryPlanAutomationRunbookActionDetails

Name Description Value
instanceType Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). 'AutomationRunbookActionDetails'
fabricLocation The fabric location. 'Primary'
'Recovery'
runbookId The runbook ARM Id. string
timeout The runbook timeout. string

RecoveryPlanManualActionDetails

Name Description Value
instanceType Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). 'ManualActionDetails'
description The manual action description. string

RecoveryPlanScriptActionDetails

Name Description Value
instanceType Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). 'ScriptActionDetails'
fabricLocation The fabric location. 'Primary'
'Recovery'
path The script path. string (required)
timeout The script timeout. string

RecoveryPlanProtectedItem

Name Description Value
id The ARM Id of the recovery plan protected item. string
virtualMachineId The virtual machine Id. string