Replication Recovery Plans - Failover Commit

Service:: Recovery Services - Site Recovery

API Version:: 2025-02-01

Execute commit failover of the recovery plan.
The operation to commit the failover of a recovery plan.

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

URI Parameters

Name	In	Required	Type	Description
recoveryPlanName	path	True	string	Recovery plan name.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	RecoveryPlan	OK
202 Accepted		Accepted

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 commit 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/failoverCommit?api-version=2025-02-01

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=2025-02-01

{
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1",
  "name": "RPtest1",
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "properties": {
    "friendlyName": "RPtest1",
    "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1",
    "primaryFabricFriendlyName": "cloud1",
    "recoveryFabricId": "Microsoft Azure",
    "recoveryFabricFriendlyName": "Microsoft Azure",
    "failoverDeploymentModel": "ResourceManager",
    "replicationProviders": [
      "HyperVReplicaAzure"
    ],
    "allowedOperations": [
      "PlannedFailover",
      "UnplannedFailover",
      "TestFailover"
    ],
    "lastPlannedFailoverTime": "2017-04-27T07:33:49.1372448Z",
    "lastTestFailoverTime": "2017-04-27T07:00:27.8354747Z",
    "currentScenario": {
      "scenarioName": "CommitFailover",
      "jobId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/5276a7bc-12a3-43a1-bc53-9bf80e0be87b",
      "startTime": "2017-04-27T08:52:42.1587592Z"
    },
    "currentScenarioStatus": "Succeeded",
    "currentScenarioStatusDescription": "Completed",
    "groups": [
      {
        "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": [],
        "endGroupActions": []
      }
    ]
  }
}

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=2025-02-01
Retry-After: 30

Definitions

Name	Description
CurrentScenarioDetails	Current scenario details of the protected entity.
ExtendedLocation	Extended location of the resource.
ExtendedLocationType	The extended location type.
PossibleOperationsDirections	The list of failover directions.
RecoveryPlan	Recovery plan details.
RecoveryPlanA2ADetails	Recovery plan A2A specific details.
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.
RecoveryPlanManualActionDetails	Recovery plan manual action details.
RecoveryPlanProperties	Recovery plan properties.
RecoveryPlanProtectedItem	Recovery plan protected item.
RecoveryPlanScriptActionDetails	Recovery plan script action details.
ReplicationProtectedItemOperation	The list of failover types.

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.

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

PossibleOperationsDirections

Enumeration

The list of failover directions.

Value	Description
PrimaryToRecovery
RecoveryToPrimary

RecoveryPlan

Object

Recovery plan details.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	RecoveryPlanProperties	The custom details.
type	string	Resource Type

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.

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
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
Boot
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).

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
Commit
PlannedFailover
UnplannedFailover
DisableProtection
TestFailover
TestFailoverCleanup
Failback
FinalizeFailback
CancelFailover
ChangePit
RepairReplication
SwitchProtection
CompleteMigration

Share via

Replication Recovery Plans - Failover Commit

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Execute commit failover of the recovery plan.

Sample request

Sample response

Definitions

CurrentScenarioDetails

ExtendedLocation

ExtendedLocationType

PossibleOperationsDirections

RecoveryPlan

RecoveryPlanA2ADetails

RecoveryPlanAction

RecoveryPlanActionLocation

RecoveryPlanAutomationRunbookActionDetails

RecoveryPlanGroup

RecoveryPlanGroupType

RecoveryPlanManualActionDetails

RecoveryPlanProperties

RecoveryPlanProtectedItem

RecoveryPlanScriptActionDetails

ReplicationProtectedItemOperation