Databases(Failover) - Failover

Failovers a database.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover?api-version=2018-06-01-preview
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover?replicaType={replicaType}&api-version=2018-06-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True
  • string

The name of the server.

databaseName
path True
  • string

The name of the database to failover.

replicaType
query

The type of replica to be failed over.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

Successfully completed database failover.

202 Accepted

Database failover is in progress.

Other Status Codes

*** Error Responses: ***

  • 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.

  • 400 DatabaseFailoverThrottled - There was a recent failover on the database or pool if database belongs in an elastic pool.

  • 400 DatabaseFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.

  • 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.

  • 409 DatabaseNotInStateToFailover - The database is currently in a state such that failover cannot be issued.

Examples

Failover an database

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/testServer/databases/testDatabase/failover?replicaType=Primary&api-version=2018-06-01-preview

Sample Response

Definitions

ReplicaType

The type of replica to be failed over.

Name Type Description
Primary
  • string
ReadableSecondary
  • string