Replication Links - Failover

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Conmuta por error desde el servidor principal actual a este servidor.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover?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.
linkId	path	True	string	Nombre del vínculo de replicación.
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.

Respuestas

Nombre	Tipo	Description
200 OK	ReplicationLink	Conmutación por error correcta.
202 Accepted		La operación de conmutación por error está en curso. Encabezados Location: string
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 ReplicationLinksReplicationLinkNameIsInvalid: el nombre del vínculo de replicación debe ser un guid válido. 400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación. 400 ReplicationLinksReplicationLinkTypeIsInvalid: LinkType no es válido. Los valores válidos son STANDBY y GEO. 400 ReplicationLinksCreateIsNotSupported: no se admite la creación de un vínculo de replicación. 400 LedgerNoDropLink: no se puede detener la replicación geográfica porque la base de datos tiene habilitadas cargas implícitas de libro de contabilidad. Deshabilite las cargas implícitas del libro de contabilidad y vuelva a intentar la operación. 400 InvalidServerName: nombre de servidor no válido especificado. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 400 TokenTooLong: el token proporcionado es demasiado largo. 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio 400 InvalidServerName: nombre de servidor no válido especificado. 400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación. 400 CannotUseTrailingWhitespacesInDatabaseName: error en la validación del nombre de la base de datos. 400 IncorrectReplicationLinkState: la operación espera que la base de datos esté en un estado esperado en el vínculo de replicación. 400 PlannedFailoverTimedOut: el usuario invocó la conmutación por error planeada y agota el tiempo de espera al intentar ponerse en contacto con el servicio de administración de partners. 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave: no se admite la configuración de la replicación geográfica para las bases de datos que usan valores diferentes de la propiedad preferredEnclaveType. La base de datos " principal "{0}" en el servidor "{1}" usa el "{2}" preferredEnclaveType, mientras que el preferredEnclaveType especificado para la base de datos secundaria "{3}" en el servidor "{4}" es "{5}". 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes: la conmutación por error planeada entre la base de datos principal y secundaria con diferentes preferredEnclaveType no se admite para enclaves de seguridad basada en virtualización (VBS). 400 CannotUseReservedDatabaseName: no se puede usar el nombre reservado de la base de datos en esta operación. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 404 OperationIdNotFound: la operación con id. no existe. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 OperationIdNotFound: la operación con id. no existe. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 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. 409 UpdateSloInProgress: el usuario intentó iniciar una operación incompatible mientras estaba en curso una actualización de SLO. 409 InvalidOperationForDatabaseNotInReplicationRelationship: se realizó una operación de replicación en una base de datos que no está en una relación de replicación. 409 ConflictingSystemOperationInProgress: una operación de mantenimiento del sistema está en curso en la base de datos y las operaciones adicionales deben esperar hasta que se complete. 409 DuplicateGeoDrRelation: las bases de datos ya están en una relación de replicación. Se trata de una solicitud duplicada. 409 GeoReplicationCannotBecomePrimaryDuringUndo: el usuario intentó conmutar por error o forzar la finalización de un vínculo geográfico mientras la base de datos secundaria está en un estado en el que es posible que no sea físicamente coherente y, por tanto, no pueda entrar en el rol principal. 409 ManagementServiceDatabaseBusy : la base de datos '{0}' está ocupada con otra operación. Pruebe la operación más adelante. 409 FailoverGroupAlreadySetup: la operación no se puede realizar porque el vínculo de replicación geográfica forma parte de un grupo de conmutación por error. Debe quitar la base de datos del grupo para finalizar o conmutar por error individualmente. 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.

Nombre

Tipo

Description

200 OK

ReplicationLink

Conmutación por error correcta.

202 Accepted

La operación de conmutación por error está en curso.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 ReplicationLinksReplicationLinkNameIsInvalid: el nombre del vínculo de replicación debe ser un guid válido.
400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación.
400 ReplicationLinksReplicationLinkTypeIsInvalid: LinkType no es válido. Los valores válidos son STANDBY y GEO.
400 ReplicationLinksCreateIsNotSupported: no se admite la creación de un vínculo de replicación.
400 LedgerNoDropLink: no se puede detener la replicación geográfica porque la base de datos tiene habilitadas cargas implícitas de libro de contabilidad. Deshabilite las cargas implícitas del libro de contabilidad y vuelva a intentar la operación.
400 InvalidServerName: nombre de servidor no válido especificado.
400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido.
400 TokenTooLong: el token proporcionado es demasiado largo.
400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención
400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio
400 InvalidServerName: nombre de servidor no válido especificado.
400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación.
400 CannotUseTrailingWhitespacesInDatabaseName: error en la validación del nombre de la base de datos.
400 IncorrectReplicationLinkState: la operación espera que la base de datos esté en un estado esperado en el vínculo de replicación.
400 PlannedFailoverTimedOut: el usuario invocó la conmutación por error planeada y agota el tiempo de espera al intentar ponerse en contacto con el servicio de administración de partners.
400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave: no se admite la configuración de la replicación geográfica para las bases de datos que usan valores diferentes de la propiedad preferredEnclaveType. La base de datos " principal "{0}" en el servidor "{1}" usa el "{2}" preferredEnclaveType, mientras que el preferredEnclaveType especificado para la base de datos secundaria "{3}" en el servidor "{4}" es "{5}".
400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes: la conmutación por error planeada entre la base de datos principal y secundaria con diferentes preferredEnclaveType no se admite para enclaves de seguridad basada en virtualización (VBS).
400 CannotUseReservedDatabaseName: no se puede usar el nombre reservado de la base de datos en esta operación.
400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido.
404 OperationIdNotFound: la operación con id. no existe.
404 ResourceNotFound: no se encontró el recurso solicitado.
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 OperationIdNotFound: la operación con id. no existe.
404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.
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.
409 UpdateSloInProgress: el usuario intentó iniciar una operación incompatible mientras estaba en curso una actualización de SLO.
409 InvalidOperationForDatabaseNotInReplicationRelationship: se realizó una operación de replicación en una base de datos que no está en una relación de replicación.
409 ConflictingSystemOperationInProgress: una operación de mantenimiento del sistema está en curso en la base de datos y las operaciones adicionales deben esperar hasta que se complete.
409 DuplicateGeoDrRelation: las bases de datos ya están en una relación de replicación. Se trata de una solicitud duplicada.
409 GeoReplicationCannotBecomePrimaryDuringUndo: el usuario intentó conmutar por error o forzar la finalización de un vínculo geográfico mientras la base de datos secundaria está en un estado en el que es posible que no sea físicamente coherente y, por tanto, no pueda entrar en el rol principal.
409 ManagementServiceDatabaseBusy : la base de datos '{0}' está ocupada con otra operación. Pruebe la operación más adelante.
409 FailoverGroupAlreadySetup: la operación no se puede realizar porque el vínculo de replicación geográfica forma parte de un grupo de conmutación por error. Debe quitar la base de datos del grupo para finalizar o conmutar por error individualmente.
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

Planned failover of a replication link

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb/failover?api-version=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ReplicationLinkFailover.json
// this example is just showing the usage of "ReplicationLinks_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 SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "4891ca10-ebd0-47d7-9182-c722651780fb";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.FailoverAsync(WaitUntil.Completed);
SqlServerDatabaseReplicationLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDatabaseReplicationLinkData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "role": "Primary",
    "partnerRole": "Secondary",
    "replicationMode": "ASYNC",
    "startTime": "2018-06-21T08:12:43.783Z",
    "percentComplete": 100,
    "replicationState": "CATCH_UP",
    "isTerminationAllowed": true,
    "linkType": "GEO"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "name": "4891ca10-ebd0-47d7-9182-c722651780fb"
}

status code:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/replicationLinksOperationResults/replicationlink-group-test-3?api-version=2022-05-01-preview

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ReplicationLink	Vínculo de replicación.
ReplicationLinkType	Tipo de vínculo (GEO, NAMED, STANDBY). La operación de actualización no admite NAMED.
ReplicationRole	Rol de replicación local.
ReplicationState	Estado de replicación (PENDIENTE, SEEDING, CATCHUP, SUSPENDED).

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.