Replication Recovery Plans - Planned Failover

Service:: Recovery Services - Site Recovery

API Version:: 2026-05-01

Execute planned failover of the recovery plan.
The operation to start the planned failover of a recovery plan.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover?api-version=2026-05-01

URI Parameters

Name	In	Required	Type	Description
recoveryPlanName	path	True	string	Name of the recovery plan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
resourceName	path	True	string	The name of the Vault
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties	True	RecoveryPlanPlannedFailoverInputProperties	The recovery plan planned failover input properties.

Responses

Name	Type	Description
200 OK	RecoveryPlan	Azure operation completed successfully.
202 Accepted		Resource operation accepted. Headers Location: string Retry-After: integer

Name

Type

Description

200 OK

RecoveryPlan

Azure operation completed successfully.

202 Accepted

Resource operation accepted.

Headers

Location: string
Retry-After: integer

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Execute planned failover of the recovery plan.

Sample request

HTTP

POST https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1/plannedFailover?api-version=2026-05-01

{
  "properties": {
    "failoverDirection": "PrimaryToRecovery",
    "providerSpecificDetails": [
      {
        "instanceType": "HyperVReplicaAzure"
      }
    ]
  }
}

Sample response

Status code:: 200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2026-05-01

{
  "name": "RPtest1",
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1",
  "properties": {
    "allowedOperations": [
      "PlannedFailover",
      "UnplannedFailover",
      "TestFailover",
      "Commit"
    ],
    "currentScenario": {
      "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/d4821a53-90da-4fcb-bc11-a280d13e3350",
      "scenarioName": "PlannedFailover",
      "startTime": "2017-04-27T07:34:02.6176524Z"
    },
    "currentScenarioStatus": "Succeeded",
    "currentScenarioStatusDescription": "Completed",
    "failoverDeploymentModel": "ResourceManager",
    "friendlyName": "RPtest1",
    "groups": [
      {
        "endGroupActions": [],
        "groupType": "Shutdown",
        "replicationProtectedItems": [],
        "startGroupActions": []
      },
      {
        "endGroupActions": [],
        "groupType": "Failover",
        "replicationProtectedItems": [],
        "startGroupActions": []
      },
      {
        "endGroupActions": [],
        "groupType": "Boot",
        "replicationProtectedItems": [
          {
            "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b",
            "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b"
          }
        ],
        "startGroupActions": []
      },
      {
        "endGroupActions": [],
        "groupType": "Boot",
        "replicationProtectedItems": [
          {
            "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6",
            "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6"
          }
        ],
        "startGroupActions": []
      }
    ],
    "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z",
    "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z",
    "primaryFabricFriendlyName": "cloud1",
    "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1",
    "recoveryFabricFriendlyName": "Microsoft Azure",
    "recoveryFabricId": "Microsoft Azure",
    "replicationProviders": [
      "HyperVReplicaAzure"
    ]
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2026-05-01
Retry-After: 30

Definitions

Name	Description
A2ARpRecoveryPointType	The recovery point type.
AlternateLocationRecoveryOption	The ALR option.
createdByType	The type of identity that created the resource.
CurrentScenarioDetails	Current scenario details of the protected entity.
DataSyncStatus	The data sync option.
ExtendedLocation	Extended location of the resource.
ExtendedLocationType	The extended location type.
HyperVReplicaAzureRpRecoveryPointType	The recovery point type.
InMageRcmFailbackRecoveryPointType	The recovery point type.
InMageV2RpRecoveryPointType	The recovery point type.
MultiVmSyncPointOption	A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.
PossibleOperationsDirections	The failover direction.
RecoveryPlan	Recovery plan details.
RecoveryPlanA2ADetails	Recovery plan A2A specific details.
RecoveryPlanA2AFailoverInput	Recovery plan A2A failover input.
RecoveryPlanAction	Recovery plan action details.
RecoveryPlanActionLocation	The fabric location.
RecoveryPlanAutomationRunbookActionDetails	Recovery plan Automation runbook action details.
RecoveryPlanGroup	Recovery plan group details.
RecoveryPlanGroupType	The group type.
RecoveryPlanHyperVReplicaAzureFailbackInput	Recovery plan HVR Azure failback input.
RecoveryPlanHyperVReplicaAzureFailoverInput	Recovery plan HVR Azure failover input.
RecoveryPlanInMageAzureV2FailoverInput	Recovery plan InMageAzureV2 failover input.
RecoveryPlanInMageFailoverInput	Recovery plan InMage failover input.
RecoveryPlanInMageRcmFailbackFailoverInput	Recovery plan InMageRcmFailback failover input.
RecoveryPlanInMageRcmFailoverInput	Recovery plan InMageRcm failover input.
RecoveryPlanManualActionDetails	Recovery plan manual action details.
RecoveryPlanPlannedFailoverInput	Recovery plan planned failover input.
RecoveryPlanPlannedFailoverInputProperties	Recovery plan planned failover input properties.
RecoveryPlanPointType	The recovery point type.
RecoveryPlanProperties	Recovery plan properties.
RecoveryPlanProtectedItem	Recovery plan protected item.
RecoveryPlanScriptActionDetails	Recovery plan script action details.
ReplicationProtectedItemOperation	The list of failover types.
RpInMageRecoveryPointType	The recovery point type.
systemData	Metadata pertaining to creation and last modification of the resource.

A2ARpRecoveryPointType

Enumeration

The recovery point type.

Value	Description
Latest	Latest
LatestApplicationConsistent	LatestApplicationConsistent
LatestCrashConsistent	LatestCrashConsistent
LatestProcessed	LatestProcessed

AlternateLocationRecoveryOption

Enumeration

The ALR option.

Value	Description
CreateVmIfNotFound	CreateVmIfNotFound
NoAction	NoAction

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CurrentScenarioDetails

Object

Current scenario details of the protected entity.

Name	Type	Description
jobId	string	ARM Id of the job being executed.
scenarioName	string	Scenario name.
startTime	string (date-time)	Start time of the workflow.

DataSyncStatus

Enumeration

The data sync option.

Value	Description
ForDownTime	ForDownTime
ForSynchronization	ForSynchronization

ExtendedLocation

Object

Extended location of the resource.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationType	The extended location type.

ExtendedLocationType

Enumeration

The extended location type.

Value	Description
EdgeZone	EdgeZone

HyperVReplicaAzureRpRecoveryPointType

Enumeration

The recovery point type.

Value	Description
Latest	Latest
LatestApplicationConsistent	LatestApplicationConsistent
LatestProcessed	LatestProcessed

InMageRcmFailbackRecoveryPointType

Enumeration

The recovery point type.

Value	Description
ApplicationConsistent	ApplicationConsistent
CrashConsistent	CrashConsistent

InMageV2RpRecoveryPointType

Enumeration

The recovery point type.

Value	Description
Latest	Latest
LatestApplicationConsistent	LatestApplicationConsistent
LatestCrashConsistent	LatestCrashConsistent
LatestProcessed	LatestProcessed

MultiVmSyncPointOption

Enumeration

A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.

Value	Description
UseMultiVmSyncRecoveryPoint	UseMultiVmSyncRecoveryPoint
UsePerVmRecoveryPoint	UsePerVmRecoveryPoint

PossibleOperationsDirections

Enumeration

The failover direction.

Value	Description
PrimaryToRecovery	PrimaryToRecovery
RecoveryToPrimary	RecoveryToPrimary

RecoveryPlan

Object

Recovery plan details.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Resource Location
name	string	The name of the resource
properties	RecoveryPlanProperties	The custom details.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RecoveryPlanA2ADetails

Object

Recovery plan A2A specific details.

Name	Type	Description
instanceType	string: A2A	Gets the Instance type.
primaryExtendedLocation	ExtendedLocation	The primary extended location.
primaryZone	string	The primary zone.
recoveryExtendedLocation	ExtendedLocation	The recovery extended location.
recoveryZone	string	The recovery zone.

RecoveryPlanA2AFailoverInput

Object

Recovery plan A2A failover input.

Name	Type	Description
cloudServiceCreationOption	string	A value indicating whether to use recovery cloud service for TFO or not.
instanceType	string: A2A	The class type.
multiVmSyncPointOption	MultiVmSyncPointOption	A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.
recoveryPointType	A2ARpRecoveryPointType	The recovery point type.

RecoveryPlanAction

Object

Recovery plan action details.

Name	Type	Description
actionName	string	The action name.
customDetails	RecoveryPlanActionDetails: RecoveryPlanAutomationRunbookActionDetails RecoveryPlanManualActionDetails RecoveryPlanScriptActionDetails	The custom details.
failoverDirections	PossibleOperationsDirections[]	The list of failover directions.
failoverTypes	ReplicationProtectedItemOperation[]	The list of failover types.

RecoveryPlanActionLocation

Enumeration

The fabric location.

Value	Description
Primary	Primary
Recovery	Recovery

RecoveryPlanAutomationRunbookActionDetails

Object

Recovery plan Automation runbook action details.

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

RecoveryPlanGroup

Object

Recovery plan group details.

Name	Type	Description
endGroupActions	RecoveryPlanAction[]	The end group actions.
groupType	RecoveryPlanGroupType	The group type.
replicationProtectedItems	RecoveryPlanProtectedItem[]	The list of protected items.
startGroupActions	RecoveryPlanAction[]	The start group actions.

RecoveryPlanGroupType

Enumeration

The group type.

Value	Description
Shutdown	Shutdown
Boot	Boot
Failover	Failover

RecoveryPlanHyperVReplicaAzureFailbackInput

Object

Recovery plan HVR Azure failback input.

Name	Type	Description
dataSyncOption	DataSyncStatus	The data sync option.
instanceType	string: HyperVReplicaAzureFailback	The class type.
recoveryVmCreationOption	AlternateLocationRecoveryOption	The ALR option.

RecoveryPlanHyperVReplicaAzureFailoverInput

Object

Recovery plan HVR Azure failover input.

Name	Type	Description
instanceType	string: HyperVReplicaAzure	The class type.
primaryKekCertificatePfx	string	The primary KEK certificate PFX.
recoveryPointType	HyperVReplicaAzureRpRecoveryPointType	The recovery point type.
secondaryKekCertificatePfx	string	The secondary KEK certificate PFX.

RecoveryPlanInMageAzureV2FailoverInput

Object

Recovery plan InMageAzureV2 failover input.

Name	Type	Description
instanceType	string: InMageAzureV2	The class type.
recoveryPointType	InMageV2RpRecoveryPointType	The recovery point type.
useMultiVmSyncPoint	string	A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.

RecoveryPlanInMageFailoverInput

Object

Recovery plan InMage failover input.

Name	Type	Description
instanceType	string: InMage	The class type.
recoveryPointType	RpInMageRecoveryPointType	The recovery point type.

RecoveryPlanInMageRcmFailbackFailoverInput

Object

Recovery plan InMageRcmFailback failover input.

Name	Type	Description
instanceType	string: InMageRcmFailback	The class type.
recoveryPointType	InMageRcmFailbackRecoveryPointType	The recovery point type.
useMultiVmSyncPoint	string	A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.

RecoveryPlanInMageRcmFailoverInput

Object

Recovery plan InMageRcm failover input.

Name	Type	Description
instanceType	string: InMageRcm	The class type.
recoveryPointType	RecoveryPlanPointType	The recovery point type.
useMultiVmSyncPoint	string	A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.

RecoveryPlanManualActionDetails

Object

Recovery plan manual action details.

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

RecoveryPlanPlannedFailoverInput

Object

Recovery plan planned failover input.

Name	Type	Description
properties	RecoveryPlanPlannedFailoverInputProperties	The recovery plan planned failover input properties.

RecoveryPlanPlannedFailoverInputProperties

Object

Recovery plan planned failover input properties.

Name	Type	Description
failoverDirection	PossibleOperationsDirections	The failover direction.
providerSpecificDetails	RecoveryPlanProviderSpecificFailoverInput[]: RecoveryPlanA2AFailoverInput[] RecoveryPlanHyperVReplicaAzureFailbackInput[] RecoveryPlanHyperVReplicaAzureFailoverInput[] RecoveryPlanInMageAzureV2FailoverInput[] RecoveryPlanInMageFailoverInput[] RecoveryPlanInMageRcmFailbackFailoverInput[] RecoveryPlanInMageRcmFailoverInput[]	The provider specific properties.

RecoveryPlanPointType

Enumeration

The recovery point type.

Value	Description
Latest	Latest
LatestApplicationConsistent	LatestApplicationConsistent
LatestCrashConsistent	LatestCrashConsistent
LatestProcessed	LatestProcessed

RecoveryPlanProperties

Object

Recovery plan properties.

Name	Type	Description
allowedOperations	string[]	The list of allowed operations.
currentScenario	CurrentScenarioDetails	The current scenario details.
currentScenarioStatus	string	The recovery plan status.
currentScenarioStatusDescription	string	The recovery plan status description.
failoverDeploymentModel	string	The failover deployment model.
friendlyName	string	The friendly name.
groups	RecoveryPlanGroup[]	The recovery plan groups.
lastPlannedFailoverTime	string (date-time)	The start time of the last planned failover.
lastTestFailoverTime	string (date-time)	The start time of the last test failover.
lastUnplannedFailoverTime	string (date-time)	The start time of the last unplanned failover.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryFabricId	string	The primary fabric Id.
providerSpecificDetails	RecoveryPlanProviderSpecificDetails[]: RecoveryPlanA2ADetails[]	The provider id and provider specific details.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryFabricId	string	The recovery fabric Id.
replicationProviders	string[]	The list of replication providers.

RecoveryPlanProtectedItem

Object

Recovery plan protected item.

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

RecoveryPlanScriptActionDetails

Object

Recovery plan script action details.

Name	Type	Description
fabricLocation	RecoveryPlanActionLocation	The fabric location.
instanceType	string: ScriptActionDetails	Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values).
path	string	The script path.
timeout	string	The script timeout.

ReplicationProtectedItemOperation

Enumeration

The list of failover types.

Value	Description
ReverseReplicate	ReverseReplicate
Commit	Commit
PlannedFailover	PlannedFailover
UnplannedFailover	UnplannedFailover
DisableProtection	DisableProtection
TestFailover	TestFailover
TestFailoverCleanup	TestFailoverCleanup
Failback	Failback
FinalizeFailback	FinalizeFailback
CancelFailover	CancelFailover
ChangePit	ChangePit
RepairReplication	RepairReplication
SwitchProtection	SwitchProtection
CompleteMigration	CompleteMigration

RpInMageRecoveryPointType

Enumeration

The recovery point type.

Value	Description
LatestTime	LatestTime
LatestTag	LatestTag
Custom	Custom

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.