Microsoft.RecoveryServices vaults/replicationRecoveryPlans 2021-11-01

Article
12/09/2024

Bicep resource definition

The vaults/replicationRecoveryPlans 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/replicationRecoveryPlans resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-11-01' = {
  parent: resourceSymbolicName
  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'
    providerSpecificInput: [
      {
        instanceType: 'string'
        // For remaining properties, see RecoveryPlanProviderSpecificInput objects
      }
    ]
    recoveryFabricId: 'string'
  }
}

RecoveryPlanProviderSpecificInput objects

Set the instanceType property to specify the type of object.

For A2A, use:

{
  instanceType: 'A2A'
  primaryExtendedLocation: {
    name: 'string'
    type: 'string'
  }
  primaryZone: 'string'
  recoveryExtendedLocation: {
    name: 'string'
    type: 'string'
  }
  recoveryZone: 'string'
}

RecoveryPlanActionDetails objects

Set the instanceType property to specify the type of object.

For AutomationRunbookActionDetails, use:

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

For ManualActionDetails, use:

{
  description: 'string'
  instanceType: 'ManualActionDetails'
}

For ScriptActionDetails, use:

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

Property values

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

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)
providerSpecificInput	The provider specific input.	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	The recovery fabric Id.	string (required)

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string (required)
type	The extended location type.	'EdgeZone' (required)