Failover Groups - Update

Service:

SQL Database

Version d'API:

2021-11-01

Met à jour un groupe de basculement.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
failoverGroupName	path	True	string	Nom du groupe de basculement.
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 contenant le groupe de basculement.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.databases	string[]	Liste des bases de données dans le groupe de basculement.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
tags	object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	FailoverGroup	Mise à jour réussie du groupe de basculement.
202 Accepted		Accepté
Other Status Codes		Réponses d’erreur : *** 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases : les ID de bases de données fournis ne sont pas des ID de ressources de base de données correctement construits. Pour obtenir l’exemple de mise en forme appropriée, consultez https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidPartner : le champ partenaires donné dans le corps de la demande de groupe de basculement de création ou de mise à jour est vide ou non valide. Indiquez une valeur valide de ce champ. Pour obtenir des exemples de demandes correctement mises en forme, consultez https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner : un ou plusieurs des serveurs partenaires fournis font déjà partie du groupe de basculement. Vérifiez que le serveur principal et tous les serveurs partenaires donnés sont uniques. 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer : une ou plusieurs des bases de données fournies n’existent pas sur le serveur principal du groupe de basculement. Assurez-vous que toutes les bases de données existent sur le serveur principal. 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount : un seul serveur partenaire pour le groupe de basculement est pris en charge. Modifiez votre demande en conséquence. Pour obtenir des exemples de demandes valides, consultez https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint : le champ readWriteEndpoint est requis pour les demandes de création ou de mise à jour. 400 FailoverGroupCreateOrUpdateRequestInvalid : le corps de la demande de groupe de basculement de création ou de mise à jour est vide ou non valide. 400 FailoverGroupUpdateOrDeleteRequestOnSecondary : les modifications apportées au groupe de basculement ne sont pas autorisées sur un serveur secondaire. Exécutez la demande sur le serveur principal. 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues : la valeur de période de grâce pour le point de terminaison en lecture-écriture doit être non négative. 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues : la valeur de la période de grâce pour le groupe de basculement doit être supérieure ou égale à la période de grâce minimale «{0} » minutes 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields : la propriété failoverWithDataLossGracePeriodMinutes doit être fournie lorsque la stratégie de basculement Automatique est sélectionnée pour le point de terminaison en lecture-écriture. 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy : le champ failoverPolicy pour le point de terminaison en lecture-écriture est requis pour les demandes de création ou de mise à jour. 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - La valeur de période de grâce ne doit pas être fournie lorsque la stratégie de basculement Manual est sélectionnée pour le point de terminaison en lecture-écriture. Supprimez-le de la demande. 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified : le corps de la demande de groupe de basculement de création ou de mise à jour ne doit pas modifier la propriété en lecture seule '{0}'. 400 FailoverGroupFailoverRequestOnPrimary : la demande de basculement doit être lancée sur le serveur secondaire du groupe de basculement. 400 FailoverGroupPartnerServerFromDifferentSubscription : le serveur principal et les serveurs partenaires du groupe de basculement proviennent d’abonnements différents. L’abonnement croisé pour les serveurs du groupe de basculement n’est pas autorisé. 400 InvalidAddSecondaryPermission : l’utilisateur ne dispose pas des autorisations suffisantes pour ajouter des données secondaires sur le serveur spécifié. 400 InvalidSku : l’utilisateur a spécifié une référence sku non valide. 400 ServerNotFound : le serveur demandé est introuvable. 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition de base de données actuelle. 400 TokenTooLong : le jeton fourni est trop long. 400 InvalidTargetSubregion : le serveur cible d’un secondaire non lisible ne se trouve pas dans une région Azure associée à la récupération d’urgence. 400 PartnerServerNotCompatible : l’utilisateur tente de copier une base de données d’un serveur SAWA V1 vers un serveur Sterling ou inversement. 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 ResourcePoolNotFound : le pool élastique spécifié n’existe pas dans le serveur logique spécifié. 400 AzureKeyVaultKeyDisabled : l’opération n’a pas pu être effectuée sur le serveur, car la clé Azure Key Vault est désactivée. 400 AzureKeyVaultInvalidExpirationDate : l’opération n’a pas pu être terminée, car la date d’expiration de la clé Azure Key Vault n’est pas valide. 400 SecurityAzureKeyVaultUrlNullOrEmpty : l’opération n’a pas pu être effectuée, car l’URI Azure Key Vault est null ou vide. 400 AzureKeyVaultNoServerIdentity : l’identité du serveur n’est pas correctement configurée. 400 AzureKeyVaultInvalidUri : réponse non valide d’Azure Key Vault. Utilisez un URI azure Key Vault valide. 400 AzureKeyVaultMissingPermissions : le serveur ne dispose pas des autorisations requises sur le Key Vault Azure. 400 SecurityAzureKeyVaultInvalidKeyName : l’opération n’a pas pu être effectuée en raison d’un nom de clé de serveur non valide. 400 PlannedFailoverTimedOutForDatabase : l’utilisateur a appelé basculement planifié, il a expiré et une base de données spécifique semble être à blâmer. 400 PlannedFailoverTimedOut : l’utilisateur a appelé basculement planifié et il a expiré lors de la tentative de contact avec le service de gestion des partenaires. 400 AdalGenericError : l’opération n’a pas pu être terminée, car une erreur Azure Active Directory a été rencontrée. 400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable de la bibliothèque Azure Active Directory a été rencontrée. 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide. 400 CannotUseReservedDatabaseName : impossible d’utiliser le nom de la base de données réservée dans cette opération. 400 InvalidFailoverGroupRegion : les serveurs spécifiés dans un groupe de basculement doivent résider dans différentes régions pour assurer l’isolation. 400 FailoverGroupDoesNotExist : le groupe de basculement n’existe pas sur un serveur. 400 FailoverGroupNotSecondary : le basculement ne peut pas être lancé à partir du serveur principal dans un groupe de basculement. 400 InvalidServerName : nom de serveur non valide spécifié. 400 DatabaseInFailoverGroupNotPrimary - Lien GeoDR pour la base de données existe déjà, mais son rôle n’est pas « Principal » ou il n’est pas un lien de copie continue. 400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat Azure Key Vault principal a expiré. 400 CannotToCreateFailoverGroupDueToTableAuditing - Impossible de créer un groupe de basculement pour le serveur sur lequel l’audit de table est activé. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 400 UnableToAddDbWithTableAuditingToFailoverGroup - La base de données avec l’audit de table activé n’est pas accessible via le point de terminaison du groupe de basculement. 400 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI de Key Vault fourni n’est pas valide. 400 KeyMaterialNotFoundOnRemoteServer : le serveur distant n’a pas accès au matériel de clé utilisé comme protecteur TDE. 400 LimitOfFailoverGroupsPerServerExceededed : la création d’un groupe de basculement dépassera le nombre autorisé de groupes de basculement par serveur. 400 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé provenant du même coffre de clés que le protecteur de chiffrement du serveur principal avec la rotation automatique des clés activée. 400 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise la taille ou le type de clé RSA non pris en charge. La taille de clé RSA prise en charge est 2048 ou 3072 et le type de clé est RSA ou RSA-HSM. 400 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal. 400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 GeoReplicaLimitReached : la limite de réplication par réplica a été atteinte. 400 FailoverGroupWithVirtualNetworkRulesNotSupported - Les groupes de basculement configurés avec une stratégie de basculement automatique ne sont actuellement pas pris en charge sur les serveurs configurés avec des règles de pare-feu de réseau virtuel. Configurez le groupe de basculement avec une stratégie de basculement manuel. 400 UnableToResolveRemoteServer : le nom du serveur partenaire distant n’a pas pu être résolu en raison d’un nom de serveur non valide ou de problèmes de connectivité DNS. 400 RemoteDatabaseCopyPermission : l’utilisateur n’a pas l’autorisation suffisante pour créer une copie de base de données sur le serveur spécifié. 400 SecurityAzureKeyVaultGeoChainError - La création d’une instance secondaire (un processus appelé chaînage) n’est pas prise en charge lors de l’activation du chiffrement transparent des données à l’aide d’Azure Key Vault (BYOK). 400 FailoverGroupCreateOrUpdatePartiallySucceeded : certaines bases de données n’ont pas pu être ajoutées ou supprimées. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 ResourceNotFound : la ressource demandée est introuvable. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié. 404 SourceDatabaseNotFound : la base de données source n’existe pas. 405 UnsupportedReplicationOperation : une opération de réplication non prise en charge a été lancée sur la base de données. 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 ConflictingServerOperation : une opération est actuellement en cours pour le serveur. 409 SubscriptionDisabled - L’abonnement est désactivé. 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 GeoReplicationCannotBecomePrimaryDuringUndo : l’utilisateur a tenté de basculer ou de forcer l’arrêt d’un lien géographique alors que le secondaire est dans un état où il n’est peut-être pas physiquement cohérent et ne peut donc pas entrer le rôle principal. 409 ServerKeyNameAlreadyExists : la clé de serveur existe déjà sur le serveur. 409 ServerKeyUriAlreadyExists : l’URI de clé de serveur existe déjà sur le serveur. 409 ServerKeyDoesNotExists - la clé du serveur n’existe pas. 409 UpdateSloInProgress : l’utilisateur a tenté de lancer une opération incompatible alors qu’une mise à jour SLO était en cours. 409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être effectuée, car le nom de la clé Azure Key Vault n’existe pas. 409 AzureKeyVaultKeyInUse : la clé est actuellement utilisée par le serveur. 409 FailoverGroupAlreadyExists : un groupe de basculement existe déjà sur un serveur donné. Utilisez un nom de groupe de basculement différent. 409 FailoverGroupBusy - Le groupe de basculement est occupé par une autre opération. 409 DatabaseBelongsToOtherFailoverGroup - La base de données appartient à un autre groupe de basculement et ne peut pas être considéré comme faisant partie de celui-ci. 409 DatabaseBeingAddedToFailoverGroup : la base de données est actuellement ajoutée au groupe de basculement. Le client doit attendre que cette opération se termine pour supprimer le problème. 409 DatabaseBeingRemovedFromFailoverGroup : la base de données est en cours de suppression du groupe de basculement, le client doit attendre que cette opération se termine pour l’ajout du problème. 409 FailoverGroupDnsRecordInUse : un enregistrement DNS en double existe pour le point de terminaison demandé. 409 InvalidFailoverGroupName - Nom du groupe de basculement non valide a été fourni. 409 InvalidOperationForDatabaseNotInReplicationRelationship : une opération d’amorçage de réplication a été effectuée sur une base de données qui se trouve déjà dans une relation de réplication. 409 InvalidDatabaseStateForOperation : l’opération n’est pas autorisée sur la base de données dans son état de réplication actuel. 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 RemoteDatabaseExists : le nom de la base de données de destination existe déjà sur le serveur de destination. 409 FailoverGroupUnableToPerformGroupOperationOnDatabases : la liste des bases de données à ajouter/supprimer dans/à partir du groupe de basculement contient des erreurs qui empêchent l’opération de se terminer. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes 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à du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être effectuée sur le serveur, car les tentatives de connexion à Azure Key Vault ont échoué 503 AzureKeyVaultGenericConnectionError : l’opération n’a pas pu être terminée, car une erreur a été rencontrée lors de la tentative de récupération des informations Key Vault . 503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible. 504 RequestTimeout - La demande de service a dépassé le délai d’expiration autorisé.

Exemples

Update failover group

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2021-11-01

{
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ]
  }
}

Java

import com.azure.resourcemanager.sql.models.FailoverGroupReadWriteEndpoint;
import com.azure.resourcemanager.sql.models.FailoverGroupUpdate;
import com.azure.resourcemanager.sql.models.ReadWriteEndpointFailoverPolicy;
import java.util.Arrays;

/**
 * Samples for FailoverGroups Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/FailoverGroupUpdate.json
     */
    /**
     * Sample code: Update failover group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getFailoverGroups()
            .update("Default", "failover-group-primary-server", "failover-group-test-1", new FailoverGroupUpdate()
                .withReadWriteEndpoint(
                    new FailoverGroupReadWriteEndpoint().withFailoverPolicy(ReadWriteEndpointFailoverPolicy.AUTOMATIC)
                        .withFailoverWithDataLossGracePeriodMinutes(120))
                .withDatabases(Arrays.asList(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1")),
                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

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "location": "Japan East",
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ]
  }
}

Code d’état:

202

Définitions

Nom	Description
FailoverGroup	Un groupe de basculement.
FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
FailoverGroupReplicationRole	Rôle de réplication locale du groupe de basculement instance.
FailoverGroupUpdate	Une demande de mise à jour de groupe de basculement.
PartnerInfo	Informations sur le serveur partenaire pour le groupe de basculement.
ReadOnlyEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.
ReadWriteEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, le basculementWithDataLossGracePeriodMinutes est requis.

FailoverGroup

Un groupe de basculement.

Nom	Type	Description
id	string	ID de la ressource
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.databases	string[]	Liste des bases de données dans le groupe de basculement.
properties.partnerServers	PartnerInfo[]	Liste des informations du serveur partenaire pour le groupe de basculement.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
properties.replicationRole	FailoverGroupReplicationRole	Rôle de réplication locale du groupe de basculement instance.
properties.replicationState	string	État de réplication du groupe de basculement instance.
tags	object	Balises de ressource.
type	string	Type de ressource.

FailoverGroupReadOnlyEndpoint

Point de terminaison en lecture seule du groupe de basculement instance.

Nom	Type	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.

FailoverGroupReadWriteEndpoint

Point de terminaison en lecture-écriture du groupe de basculement instance.

Nom	Type	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, le basculementWithDataLossGracePeriodMinutes est requis.
failoverWithDataLossGracePeriodMinutes	integer	Période de grâce avant la tentative de basculement avec perte de données pour le point de terminaison en lecture-écriture. Si failoverPolicy est automatique, le basculementWithDataLossGracePeriodMinutes est requis.

FailoverGroupReplicationRole

Rôle de réplication locale du groupe de basculement instance.

Nom	Type	Description
Primary	string
Secondary	string

FailoverGroupUpdate

Une demande de mise à jour de groupe de basculement.

Nom	Type	Description
properties.databases	string[]	Liste des bases de données dans le groupe de basculement.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
tags	object	Balises de ressource.

PartnerInfo

Informations sur le serveur partenaire pour le groupe de basculement.

Nom	Type	Description
id	string	Identificateur de ressource du serveur partenaire.
location	string	Emplacement géographique du serveur partenaire.
replicationRole	FailoverGroupReplicationRole	Rôle de réplication du serveur partenaire.

ReadOnlyEndpointFailoverPolicy

Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.

Nom	Type	Description
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, le basculementWithDataLossGracePeriodMinutes est requis.

Nom	Type	Description
Automatic	string
Manual	string