通过

Failover - Perform Force Failover

Service:
Power Platform API
API Version:
2022-03-01-preview

Performs force failover for the specified environment. Environment will be switched from it's current region to it's paired region as of LastSyncTime. Data changed or updated after this time will not be restored. By providing this value, the customer acknowledges that the data might be lost after this time during the failover operation (Preview).

POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/forceFailover?api-version=2022-03-01-preview
With optional parameters: 
POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/forceFailover?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
environmentId
 path True

string

The ID of the environment.
api-version
 query True

string

The API version.
ValidateOnly
 query

boolean

The value which indicates whether the operation is a validated only request. Examples:

validateOnly=true with validateProperties non-empty: Validate only the listed properties, ignoring others even if present in the body.

validateOnly=true with empty/absent validateProperties: Validate the entire body (equivalent to full validation).

validateOnly=false or omitted: Process the full request(validate and execute).
ValidateProperties
 query

string

The value which indicates what properties should be validated. Need to work together with ValidateOnly. Properties should be separated by ','. Example: "property1,property2,property3".

Request Body

Media Types: "application/json", "text/json", "application/*+json"

Name Required Type Description
lastSyncTime True

string (date-time)

Gets or sets the last sync time that will be used to perform the force failover operation.

Responses

Name Type Description
201 Created

OperationExecutionResult

Created

Media Types: "text/plain", "application/json", "text/json"
400 Bad Request

Bad Request

Media Types: "text/plain", "application/json", "text/json"
Other Status Codes

Conflict

Media Types: "text/plain", "application/json", "text/json"

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name Description
.default .default

Definitions

Name Description
Environment

Power platform Environment
ErrorInfo

Represents error information for an operation.
ForceFailoverRequest

Request model for force failover operation on an environment.
OperationExecutionResult

Represents the result of an operation execution.
OperationStatus

The status of operation.
StageStatus

The stage status of an operation.
UserIdentity

Represents the identity of a user.

Environment

Object

Power platform Environment

Name Type Description
dataverseOrganizationUrl

string

Dataverse organization URL of the environment.
displayName

string

Display name of the environment.
environmentId

string

The environment ID.

ErrorInfo

Object

Represents error information for an operation.

Name Type Description
code

string

The error Code.
fieldErrors

object

The detailed error.

ForceFailoverRequest

Object

Request model for force failover operation on an environment.

Name Type Description
lastSyncTime

string (date-time)

Gets or sets the last sync time that will be used to perform the force failover operation.

OperationExecutionResult

Object

Represents the result of an operation execution.

Name Type Description
endTime

string (date-time)

The end time of the operation.
errorDetail

ErrorInfo

Represents error information for an operation.
name

string

The name of the operation.
operationId

string

The ID of the operation.
requestedBy

UserIdentity

Represents the identity of a user.
stageStatuses

StageStatus[]

The list of State statuses associated with the operation.
startTime

string (date-time)

The start time of the operation.
status

OperationStatus

The status of operation.
updatedEnvironment

Environment

Power platform Environment

OperationStatus

Enumeration

The status of operation.

Value Description
Queued
InProgress
Succeeded
ValidationFailed
Failed
NoOperation
ValidationPassed

StageStatus

Object

The stage status of an operation.

Name Type Description
endTime

string (date-time)

The end time of the stage.
errorDetail

ErrorInfo

Represents error information for an operation.
name

string

The name of the stage.
startTime

string (date-time)

The start time of the stage.
status

string

The status of the stage.

UserIdentity

Object

Represents the identity of a user.

Name Type Description
displayName

string

The display name of the user.
tenantId

string

The tenant ID of the user.
userId

string

The ID of the user.