Failovers a managed instance.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover?api-version=2021-11-01
With optional parameters:
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover?replicaType={replicaType}&api-version=2021-11-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
managedInstanceName
|
path |
True
|
string
|
The name of the managed instance 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.
|
|
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 managed instance failover.
|
|
202 Accepted
|
|
Managed instance failover is in progress.
|
|
Other Status Codes
|
|
*** Error Responses: ***
400 ManagedInstanceFailoverThrottled - There was a recent failover on the managed instance.
400 ManagedInstanceFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 OperationIdNotFound - The operation with Id does not exist.
409 ManagedInstanceFailoverFullBackupMissing - Automated backup needs to complete the first full backup for a new database.
409 ManagedInstanceNotInStateToFailover - The managed instance is currently in a state such that failover cannot be issued.
409 OperationCancelled - The operation has been cancelled by user.
409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
|
Examples
Failover a managed instance.
Sample Request
POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/managedInstances/instanceName/failover?replicaType=Primary&api-version=2021-11-01
import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.ReplicaType;
/** Samples for ManagedInstances Failover. */
public final class Main {
/*
* x-ms-original-file:
* specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/FailoverManagedInstance.json
*/
/**
* Sample code: Failover a managed instance.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void failoverAManagedInstance(com.azure.resourcemanager.AzureResourceManager azure) {
azure.sqlServers().manager().serviceClient().getManagedInstances().failover("group1", "instanceName",
ReplicaType.PRIMARY, 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
Definitions
ReplicaType
The type of replica to be failed over.
| Name |
Type |
Description |
|
Primary
|
string
|
|
|
ReadableSecondary
|
string
|
|