Databases - Failover

Servicio:

SQL Database

Versión de la API:

2023-08-01

Conmuta por error una base de datos.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos que se va a realizar la conmutación por error.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.
replicaType	query		ReplicaType	Tipo de réplica que se va a conmutar por error.

Respuestas

Nombre	Tipo	Description
200 OK		Se completó correctamente la conmutación por error de la base de datos.
202 Accepted		La conmutación por error de la base de datos está en curso. Encabezados Location: string
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 DatabaseFailoverNotSupportedOnSKU: este tipo de conmutación por error iniciada por el cliente no se admite en la SKU especificada. 400 DatabaseFailoverThrottled: se produjo una conmutación por error reciente en la base de datos o grupo si la base de datos pertenece a un grupo elástico. 400 ManagementServiceFeatureDisabled: el usuario intentó usar una característica que está deshabilitada. 404 OperationIdNotFound: la operación con id. no existe. 409 DatabaseNotInStateToFailover: la base de datos está actualmente en un estado de modo que no se pueda emitir la conmutación por error. 409 ManagementServiceDatabaseBusy : la base de datos '{0}' está ocupada con otra operación. Pruebe la operación más adelante. 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

Failover an database

Solicitud de ejemplo

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=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/FailoverDatabase.json
// this example is just showing the usage of "Databases_Failover" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "testServer";
string databaseName = "testDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
ReplicaType? replicaType = ReplicaType.Primary;
await sqlDatabase.FailoverAsync(WaitUntil.Completed, replicaType: replicaType);

Console.WriteLine("Succeeded");

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

Respuesta de muestra

status code:

200

status code:

202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Sql/locations/japaneast/databaseOperationResults/00000000-0000-0000-0000-000000000000

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ReplicaType	Tipo de réplica que se va a conmutar por error.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ReplicaType

Enumeración

Tipo de réplica que se va a conmutar por error.

Valor	Description
Primary
ReadableSecondary