Replication Links - Failover

Service:: SQL Database

Version d'API:: 2023-08-01

Bascule du serveur principal actuel vers ce serveur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
linkId	path	True	string	Nom du lien de réplication.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	ReplicationLink	Basculé avec succès.
202 Accepted		L’opération de basculement est en cours. En-têtes Location: string
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ReplicationLinksReplicationLinkNameIsInvalid : le nom du lien de réplication doit être un guid valide. 400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 ReplicationLinksReplicationLinkTypeIsInvalid : LinkType n’est pas valide. Les valeurs valides sont STANDBY et GEO. 400 ReplicationLinksCreateIsNotSupported : la création d’un lien de réplication n’est pas prise en charge. 400 LedgerNoDropLink - La géoréplication ne peut pas être arrêtée, car la base de données a activé les chargements de digest de registre. Désactivez les chargements de digest du registre et réessayez l’opération. 400 InvalidServerName - Nom du serveur non valide spécifié. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 400 TokenTooLong : le jeton fourni est trop long. 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 400 InvalidServerName - Nom du serveur non valide spécifié. 400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 CannotUseTrailingWhitespacesInDatabaseName : échec de la validation du nom de la base de données. 400 IncorrectReplicationLinkState : l’opération s’attend à ce que la base de données soit dans un état attendu sur le lien de réplication. 400 PlannedFailoverTimedOut : l’utilisateur a appelé le basculement planifié et il a expiré lors de la tentative de contact avec le service de gestion des partenaires. 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave : la configuration de la géoréplication n’est pas prise en charge pour les bases de données utilisant différentes valeurs de la propriété preferredEnclaveType. La base de données «{0}» principale sur le serveur «{1}» utilise le «{2}» preferredEnclaveType, tandis que la base de données{3}secondaire spécifiée sur le serveur «{4}» est «{5}». 400 VBSEnclaveNotSupportedFor PlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Le basculement planifié entre la base de données primaire et secondaire avec des enclaves de sécurité basées sur la virtualisation (VBS) n’est pas prise en charge. 400 CannotUseReservedDatabaseName - Impossible d’utiliser le nom de la base de données réservée dans cette opération. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 ResourceNotFound : la ressource demandée est introuvable. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur. 409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 409 UpdateSloInProgress : l’utilisateur a essayé de lancer une opération incompatible pendant qu’une mise à jour SLO était en cours. 409 InvalidOperationForDatabaseNotInReplicationRelationship : une opération de réplication a été effectuée sur une base de données qui n’est pas dans une relation de réplication. 409 ConflictingSystemOperationInProgress : une opération de maintenance du système est en cours sur la base de données et d’autres opérations doivent attendre qu’elle soit terminée. 409 DuplicateGeoDrRelation : les bases de données sont déjà dans une relation de réplication. Il s’agit d’une demande en double. 409 GeoReplicationCannotBecomePrimaryDuringUndo : l’utilisateur a tenté de basculer ou de forcer l’arrêt d’un géo-lien alors que le serveur secondaire est dans un état où il peut ne pas être physiquement cohérent et ne peut donc pas entrer le rôle principal. 409 ManagementServiceDatabaseBusy - Database '{0}' est occupé avec une autre opération. Essayez votre opération ultérieurement. 409 FailoverGroupAlreadySetup : l’opération ne peut pas être effectuée, car le lien de géoréplication fait partie d’un groupe de basculement. Vous devez supprimer la base de données du groupe pour terminer ou basculer individuellement. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération. 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

Nom

Type

Description

200 OK

ReplicationLink

Basculé avec succès.

202 Accepted

L’opération de basculement est en cours.

En-têtes

Location: string

Other Status Codes

ErrorResponse

Réponses d’erreur : ***

400 ReplicationLinksReplicationLinkNameIsInvalid : le nom du lien de réplication doit être un guid valide.
400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication.
400 ReplicationLinksReplicationLinkTypeIsInvalid : LinkType n’est pas valide. Les valeurs valides sont STANDBY et GEO.
400 ReplicationLinksCreateIsNotSupported : la création d’un lien de réplication n’est pas prise en charge.
400 LedgerNoDropLink - La géoréplication ne peut pas être arrêtée, car la base de données a activé les chargements de digest de registre. Désactivez les chargements de digest du registre et réessayez l’opération.
400 InvalidServerName - Nom du serveur non valide spécifié.
400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide.
400 TokenTooLong : le jeton fourni est trop long.
400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
400 InvalidServerName - Nom du serveur non valide spécifié.
400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication.
400 CannotUseTrailingWhitespacesInDatabaseName : échec de la validation du nom de la base de données.
400 IncorrectReplicationLinkState : l’opération s’attend à ce que la base de données soit dans un état attendu sur le lien de réplication.
400 PlannedFailoverTimedOut : l’utilisateur a appelé le basculement planifié et il a expiré lors de la tentative de contact avec le service de gestion des partenaires.
400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave : la configuration de la géoréplication n’est pas prise en charge pour les bases de données utilisant différentes valeurs de la propriété preferredEnclaveType. La base de données «{0}» principale sur le serveur «{1}» utilise le «{2}» preferredEnclaveType, tandis que la base de données{3}secondaire spécifiée sur le serveur «{4}» est «{5}».
400 VBSEnclaveNotSupportedFor PlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Le basculement planifié entre la base de données primaire et secondaire avec des enclaves de sécurité basées sur la virtualisation (VBS) n’est pas prise en charge.
400 CannotUseReservedDatabaseName - Impossible d’utiliser le nom de la base de données réservée dans cette opération.
400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide.
404 OperationIdNotFound : l’opération avec ID n’existe pas.
404 ResourceNotFound : la ressource demandée est introuvable.
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 OperationIdNotFound : l’opération avec ID n’existe pas.
404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur.
409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé.
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
409 UpdateSloInProgress : l’utilisateur a essayé de lancer une opération incompatible pendant qu’une mise à jour SLO était en cours.
409 InvalidOperationForDatabaseNotInReplicationRelationship : une opération de réplication a été effectuée sur une base de données qui n’est pas dans une relation de réplication.
409 ConflictingSystemOperationInProgress : une opération de maintenance du système est en cours sur la base de données et d’autres opérations doivent attendre qu’elle soit terminée.
409 DuplicateGeoDrRelation : les bases de données sont déjà dans une relation de réplication. Il s’agit d’une demande en double.
409 GeoReplicationCannotBecomePrimaryDuringUndo : l’utilisateur a tenté de basculer ou de forcer l’arrêt d’un géo-lien alors que le serveur secondaire est dans un état où il peut ne pas être physiquement cohérent et ne peut donc pas entrer le rôle principal.
409 ManagementServiceDatabaseBusy - Database '{0}' est occupé avec une autre opération. Essayez votre opération ultérieurement.
409 FailoverGroupAlreadySetup : l’opération ne peut pas être effectuée, car le lien de géoréplication fait partie d’un groupe de basculement. Vous devez supprimer la base de données du groupe pour terminer ou basculer individuellement.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération.
503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.

Exemples

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

Exemple de réponse

Code d’état:: 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"
}

Code d’état:: 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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ReplicationLink	Lien de réplication.
ReplicationLinkType	Type de lien (GEO, NAMED, STANDBY). L’opération de mise à jour ne prend pas en charge NAMED.
ReplicationRole	Rôle de réplication local.
ReplicationState	État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ReplicationLink

Object

Lien de réplication.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.isTerminationAllowed	boolean	Indique si l’utilisateur est actuellement autorisé à terminer le lien.
properties.linkType	ReplicationLinkType	Type de lien (GEO, NAMED, STANDBY). L’opération de mise à jour ne prend pas en charge NAMED.
properties.partnerDatabase	string	Base de données du partenaire de ressources.
properties.partnerDatabaseId	string	ID de base de données du partenaire de ressources.
properties.partnerLocation	string	Emplacement du partenaire de ressource.
properties.partnerRole	ReplicationRole	Rôle de réplication de partenaire.
properties.partnerServer	string	Serveur partenaire de ressources.
properties.percentComplete	integer (int32)	Pourcentage d’achèvement d’amorçage pour le lien.
properties.replicationMode	string	Mode de réplication.
properties.replicationState	ReplicationState	État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Rôle de réplication local.
properties.startTime	string (date-time)	Heure à laquelle le lien a été créé.
type	string	Type de ressource.

ReplicationLinkType

Énumération

Type de lien (GEO, NAMED, STANDBY). L’opération de mise à jour ne prend pas en charge NAMED.

Valeur	Description
GEO
NAMED
STANDBY

ReplicationRole

Énumération

Rôle de réplication local.

Valeur	Description
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

Énumération

État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).

Valeur	Description
PENDING
SEEDING
CATCH_UP
SUSPENDED

Partager via

Replication Links - Failover

Paramètres URI

Réponses

Exemples

Planned failover of a replication link

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkType

ReplicationRole

ReplicationState