Databases - Failover

Service:

SQL Database

API Version:

2021-11-01

Failovers a database.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database to failover.
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.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.
replicaType	query		ReplicaType	The type of replica to be failed over.

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

HTTP

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=2021-11-01

Java

import com.azure.resourcemanager.sql.models.ReplicaType;

/**
 * Samples for Databases Failover.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/FailoverDatabase.json
     */
    /**
     * Sample code: Failover an database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void failoverAnDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabases().failover("group1", "testServer", "testDatabase",
            ReplicaType.PRIMARY, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

Status code:

202

Definitions

ReplicaType

The type of replica to be failed over.

Name	Type	Description
Primary	string
ReadableSecondary	string