The vaults/replicationRecoveryPlans resource type can be deployed to:
For a list of changed properties in each API version, see change log.
To create a Microsoft.RecoveryServices/vaults/replicationRecoveryPlans resource, add the following JSON to your template.
{
"type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
"apiVersion": "2022-10-01",
"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"
}
}
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"
Set the instanceType property to specify the type of object.
For A2A, use:
"instanceType": "A2A",
"primaryExtendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"primaryZone": "string",
"recoveryExtendedLocation": {
"name": "string",
"type": "EdgeZone"
},
"recoveryZone": "string"
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans' |
apiVersion | The resource api version | '2022-10-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | Recovery plan creation properties. | CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (required) |
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) |
Name | Description | Value |
---|---|---|
endGroupActions | The end group actions. | RecoveryPlanAction[] |
groupType | The group type. | 'Boot' 'Failover' 'Shutdown' (required) |
replicationProtectedItems | The list of protected items. | RecoveryPlanProtectedItem[] |
startGroupActions | The start group actions. | RecoveryPlanAction[] |
Name | Description | Value |
---|---|---|
actionName | The action name. | string (required) |
customDetails | The custom details. | RecoveryPlanActionDetails (required) |
failoverDirections | The list of failover directions. | String array containing any of: 'PrimaryToRecovery' 'RecoveryToPrimary' (required) |
failoverTypes | The list of failover types. | String array containing any of: 'CancelFailover' 'ChangePit' 'Commit' 'CompleteMigration' 'DisableProtection' 'Failback' 'FinalizeFailback' 'PlannedFailover' 'RepairReplication' 'ReverseReplicate' 'SwitchProtection' 'TestFailover' 'TestFailoverCleanup' 'UnplannedFailover' (required) |
Name | Description | Value |
---|---|---|
instanceType | Set the object type | AutomationRunbookActionDetails ManualActionDetails ScriptActionDetails (required) |
Name | Description | Value |
---|---|---|
instanceType | Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). | 'AutomationRunbookActionDetails' (required) |
fabricLocation | The fabric location. | 'Primary' 'Recovery' (required) |
runbookId | The runbook ARM Id. | string |
timeout | The runbook timeout. | string |
Name | Description | Value |
---|---|---|
instanceType | Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). | 'ManualActionDetails' (required) |
description | The manual action description. | string |
Name | Description | Value |
---|---|---|
instanceType | Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). | 'ScriptActionDetails' (required) |
fabricLocation | The fabric location. | 'Primary' 'Recovery' (required) |
path | The script path. | string (required) |
timeout | The script timeout. | string |
Name | Description | Value |
---|---|---|
id | The ARM Id of the recovery plan protected item. | string |
virtualMachineId | The virtual machine Id. | string |
Name | Description | Value |
---|---|---|
instanceType | Set the object type | A2A (required) |
Name | Description | Value |
---|---|---|
instanceType | Gets the Instance type. | 'A2A' (required) |
primaryExtendedLocation | The primary extended location. | ExtendedLocation |
primaryZone | The primary zone. | string |
recoveryExtendedLocation | The recovery extended location. | ExtendedLocation |
recoveryZone | The recovery zone. | string |
Name | Description | Value |
---|---|---|
name | The name of the extended location. | string (required) |
type | The extended location type. | 'EdgeZone' (required) |