Instance Failover Groups - List By Location

Service:

SQL Database

API Version:

2021-11-01

Répertorie les groupes de basculement d’un emplacement.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
locationName	path	True	string	Nom de la région où se trouve la ressource.
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.
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.

Réponses

Nom	Type	Description
200 OK	InstanceFailoverGroupListResult	Récupération réussie des groupes de basculement.
Other Status Codes		Réponses d’erreur : *** 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary : le champ principal donné dans créer ou mettre à jour instance corps de la demande de groupe de basculement est vide ou non valide. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner : le champ partenaires donné dans créer ou mettre à jour instance corps de la demande de groupe de basculement est vide ou non valide. 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner : un ou plusieurs des serveurs partenaires fournis font déjà partie du groupe de basculement instance. Assurez-vous que le serveur principal et tous les serveurs partenaires donnés sont uniques. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion : la région de instance gérée par le partenaire fournie dans le corps de la demande de groupe de basculement instance est vide ou non valide. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount : une seule région partenaire est prise en charge. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount : une seule paire de instance managées est prise en charge. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint : le champ readWriteEndpoint est requis pour les demandes de création ou de mise à jour. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid : le corps de la demande de groupe de basculement créé ou mis à jour instance est vide ou non valide. 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary : les modifications apportées au groupe de basculement instance ne sont pas autorisées sur un serveur secondaire. Exécutez la requête sur le serveur principal. 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues : la valeur de période de grâce pour le point de terminaison en lecture-écriture doit être non négative. 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues : la valeur de la période de grâce pour le groupe de basculement instance doit être supérieure ou égale à la période de grâce minimale «{0} » minutes 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields : la propriété failoverWithDataLossGracePeriodMinutes doit être fournie lorsque la stratégie de basculement Automatic est sélectionnée pour le point de terminaison en lecture-écriture. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy : le champ failoverPolicy pour le point de terminaison en lecture-écriture est requis pour les demandes de création ou de mise à jour. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy : la valeur de période de grâce ne doit pas être fournie lorsque le manuel de stratégie de basculement est sélectionné pour le point de terminaison en lecture-écriture. 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified : le corps de la demande de groupe de basculement de création ou de mise à jour instance ne doit pas modifier la propriété en lecture seule '{0}'. 400 InstanceFailoverGroupFailoverRequestOnPrimary : la demande de basculement doit être lancée sur le serveur secondaire de instance groupe de basculement. 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription : le serveur principal et le serveur partenaire du groupe de basculement proviennent d’abonnements différents. L’abonnement croisé pour les serveurs du groupe de basculement n’est pas autorisé. 400 FailoverGroupRegionMismatch : la région du partenaire spécifiée dans Groupe de basculement doit correspondre à la région du instance géré par le partenaire. 400 ServerEditionMismatch - Edition doit être identique au serveur principal lors de la création d’un serveur réplica. 400 DnsZoneMismatch : la zone DNSZone sur le serveur partenaire est différente de la zone DNSZone sur le serveur source. Cela interrompt la fonctionnalité InstanceFailoverGroup. 400 InvalidTargetSubregion : le serveur cible d’un serveur secondaire non lisible n’est pas dans une région Azure associée à la récupération d’urgence. 400 GeoDrInstanceSizeMismatch : les instance managés principaux et les instance managés partenaires n’ont pas la même taille de stockage. 400 SecurityAdalPrincipalCertExpiredError : l’opération n’a pas pu être effectuée, car le certificat principal Azure Key Vault a expiré. 400 GeoDrSecondaryInstanceNotEmpty : le instance managé secondaire a des bases de données utilisateur. Pour créer un groupe de basculement instance, le instance managé secondaire doit être vide. 400 InstanceFailoverGroupIncorrectNetworkingConfiguration : configuration réseau incorrecte. Le trafic de réplication du serveur principal ne peut pas atteindre le serveur secondaire. 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 SecurityInvalidAzureKeyVaultRecoveryLevel : l’URI 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 AzureKeyVaultRsaKeyNotSupported : le coffre de clés fourni utilise une taille de clé RSA ou un type de clé 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 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 SameKeyUriNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé 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 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 SameKeyMaterialNotFoundOnRemoteServer : le serveur secondaire n’a pas le matériel de clé du protecteur de chiffrement du serveur principal. 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 d’instance doivent résider dans différentes régions pour fournir une isolation. 400 InstanceFailoverGroupDoesNotExist : le groupe de basculement n’existe pas sur un serveur. 400 InstanceFailoverGroupNotSecondary : le basculement ne peut pas être lancé à partir du serveur principal dans un groupe de basculement instance. 400 InvalidServerName : nom de 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 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 InvalidSku : l’utilisateur a spécifié une référence SKU non valide. 400 InvalidAddSecondaryPermission : l’utilisateur ne dispose pas des autorisations suffisantes pour ajouter un serveur secondaire sur le serveur spécifié. 400 ServerNotFound : le serveur demandé est introuvable. 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 de Key Vault Azure valide. 400 AzureKeyVaultMissingPermissions : le serveur n’a pas les 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 responsable. 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 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 AdalServicePrincipalNotFound : l’opération n’a pas pu être terminée, car une erreur de principal de service introuvable dans la bibliothèque Azure Active Directory a été rencontrée. 400 AzureKeyVaultMalformedVaultUri : l’URI de Key Vault fourni n’est pas valide. 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition actuelle de la base de données. 404 ResourceNotFound : la ressource demandée est introuvable. 404 SourceDatabaseNotFound : la base de données source n’existe pas. 404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 405 UnsupportedReplicationOperation : une opération de réplication non prise en charge a été lancée sur la base de données. 409 ManagedInstanceHasHybridLink : l’utilisateur a essayé d’initier une opération qui n’est pas prise en charge lorsque instance managé a une liaison hybride configurée. 409 RemoteDatabaseExists : le nom de la base de données de destination existe déjà sur le serveur de destination. 409 ConflictingServerOperation : une opération est actuellement en cours pour le serveur. 409 SubscriptionDisabled - L’abonnement est désactivé. 409 InstanceFailoverGroupAlreadyExists : le groupe de basculement existe déjà sur un serveur donné. 409 InstanceFailoverGroupBusy - Le groupe de basculement d’instance est occupé par une autre opération. 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 InstanceFailoverGroupDnsRecordInUse : un enregistrement DNS en double existe pour le point de terminaison demandé. 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 InvalidFailoverGroupName - Nom du groupe de basculement d’instance non valide a été fourni. 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 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 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. 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. 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 . 504 RequestTimeout - La demande de service a dépassé le délai d’expiration autorisé.

Exemples

List failover group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for InstanceFailoverGroups ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/InstanceFailoverGroupList.json
     */
    /**
     * Sample code: List failover group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getInstanceFailoverGroups().listByLocation("Default", "Japan East",
            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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test",
      "name": "failover-group-test",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerRegions": [
          {
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "managedInstancePairs": [
          {
            "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-1",
      "name": "failover-group-test-1",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerRegions": [
          {
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "managedInstancePairs": [
          {
            "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance-1",
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance-1"
          }
        ]
      }
    }
  ]
}

Définitions

Nom	Description
InstanceFailoverGroup	Un groupe de basculement instance.
InstanceFailoverGroupListResult	Liste des groupes de basculement instance.
InstanceFailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
InstanceFailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
InstanceFailoverGroupReplicationRole	Rôle de réplication locale du groupe de basculement instance.
ManagedInstancePairInfo	Paires d’instances managées dans le groupe de basculement.
PartnerRegionInfo	Informations sur la région du 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 a la valeur Automatic, failoverWithDataLossGracePeriodMinutes est requis.

InstanceFailoverGroup

Un groupe de basculement instance.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.managedInstancePairs	ManagedInstancePairInfo[]	Liste des paires de instance managées dans le groupe de basculement.
properties.partnerRegions	PartnerRegionInfo[]	Informations sur la région du partenaire pour le groupe de basculement.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule du groupe de basculement instance.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture du groupe de basculement instance.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Rôle de réplication locale du groupe de basculement instance.
properties.replicationState	string	État de réplication du groupe de basculement instance.
type	string	Type de ressource.

InstanceFailoverGroupListResult

Liste des groupes de basculement instance.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	InstanceFailoverGroup[]	Tableau de résultats.

InstanceFailoverGroupReadOnlyEndpoint

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.

InstanceFailoverGroupReadWriteEndpoint

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 a la valeur Automatic, failoverWithDataLossGracePeriodMinutes 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 a la valeur Automatic, failoverWithDataLossGracePeriodMinutes est requis.

InstanceFailoverGroupReplicationRole

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

Nom	Type	Description
Primary	string
Secondary	string

ManagedInstancePairInfo

Paires d’instances managées dans le groupe de basculement.

Nom	Type	Description
partnerManagedInstanceId	string	ID de Managed Instance partenaire par paire.
primaryManagedInstanceId	string	ID du Managed Instance principal en paire.

PartnerRegionInfo

Informations sur la région du partenaire pour le groupe de basculement.

Nom	Type	Description
location	string	Emplacement géographique des instances managées du partenaire.
replicationRole	InstanceFailoverGroupReplicationRole	Rôle de réplication des instances managées partenaires.

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 a la valeur Automatic, failoverWithDataLossGracePeriodMinutes est requis.

Nom	Type	Description
Automatic	string
Manual	string