Microsoft.RecoveryServices vaults/replicationRecoveryPlans 2018-01-10

Template format

To create a Microsoft.RecoveryServices/vaults/replicationRecoveryPlans resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "apiVersion": "2018-01-10",
  "properties": {
    "primaryFabricId": "string",
    "recoveryFabricId": "string",
    "failoverDeploymentModel": "string",
    "groups": [
      {
        "groupType": "string",
        "replicationProtectedItems": [
          {
            "id": "string",
            "virtualMachineId": "string"
          }
        ],
        "startGroupActions": [
          {
            "actionName": "string",
            "failoverTypes": [
              "string"
            ],
            "failoverDirections": [
              "string"
            ],
            "customDetails": {
              "instanceType": "string"
            }
          }
        ],
        "endGroupActions": [
          {
            "actionName": "string",
            "failoverTypes": [
              "string"
            ],
            "failoverDirections": [
              "string"
            ],
            "customDetails": {
              "instanceType": "string"
            }
          }
        ]
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans object

Name Type Required Value
name string Yes
type enum Yes replicationRecoveryPlans
-or-
Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

See Set name and type for child resources.
apiVersion enum Yes 2018-01-10
properties object Yes Recovery plan creation properties. - CreateRecoveryPlanInputProperties object

CreateRecoveryPlanInputProperties object

Name Type Required Value
primaryFabricId string Yes The primary fabric Id.
recoveryFabricId string Yes The recovery fabric Id.
failoverDeploymentModel enum No The failover deployment model. - NotApplicable, Classic, ResourceManager
groups array Yes The recovery plan groups. - RecoveryPlanGroup object

RecoveryPlanGroup object

Name Type Required Value
groupType enum Yes The group type. - Shutdown, Boot, Failover
replicationProtectedItems array No The list of protected items. - RecoveryPlanProtectedItem object
startGroupActions array No The start group actions. - RecoveryPlanAction object
endGroupActions array No The end group actions. - RecoveryPlanAction object

RecoveryPlanProtectedItem object

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

RecoveryPlanAction object

Name Type Required Value
actionName string Yes The action name.
failoverTypes array Yes The list of failover types. - ReverseReplicate, Commit, PlannedFailover, UnplannedFailover, DisableProtection, TestFailover, TestFailoverCleanup, Failback, FinalizeFailback, ChangePit, RepairReplication, SwitchProtection, CompleteMigration
failoverDirections array Yes The list of failover directions. - PrimaryToRecovery or RecoveryToPrimary
customDetails object Yes The custom details. - RecoveryPlanActionDetails object

RecoveryPlanActionDetails object

Name Type Required Value
instanceType string Yes