Instance Failover Groups - List By Location

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-02-01-preview

Paramètres URI

Name In Required 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

Name Type Description
200 OK

Récupération réussie des groupes de basculement.

Other Status Codes

Réponses d’erreur : ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner : le champ partenaires donné dans le corps de la demande de groupe de basculement d’instance de création ou de mise à jour est vide ou non valide.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner : un ou plusieurs des serveurs partenaires fournis font déjà partie du groupe de basculement d’instance. Vérifiez que le serveur principal et tous les serveurs partenaires donnés sont uniques.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion : la région d’instance gérée partenaire fournie dans le corps de la demande de groupe de basculement d’instance est vide ou non valide.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Une seule région partenaire est prise en charge.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount : une seule paire d’instances managées est prise en charge.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint : le champ readWriteEndpoint est requis pour créer ou mettre à jour des demandes.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid : le corps de la demande de groupe de basculement de création ou de mise à jour est vide ou non valide.

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary : les modifications apportées au groupe de basculement d’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 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - 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 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy : le champ failoverPolicy du point de terminaison en lecture-écriture est requis pour les demandes de création ou de mise à jour.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - La valeur de la 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 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 du groupe de basculement d’instance.

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription - Serveur principal et serveur partenaire du groupe de basculement proviennent de différents abonnements. L’abonnement croisé pour les serveurs du groupe de basculement n’est pas autorisé.

  • 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 - L’instance managée principale et l’instance gérée partenaire 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 - L’instance managée secondaire possède des bases de données utilisateur. Pour créer un groupe de basculement d’instance, l’instance managée secondaire doit être vide.

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - La configuration réseau est 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 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 AzureKeyVaultMismatchError - Région Key Vault inattendue trouvée dans la réponse http.

  • 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 UnableToResolveRemoteServer : le nom du serveur partenaire distant n’a pas pu être résolu en raison d’un nom de serveur non valide ou d’un problème 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 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 d’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 effectué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 d’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 n’a pas l’autorisation suffisante pour ajouter 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 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é le basculement planifié, il a expiré et une base de données spécifique semble être à blâmer.

  • 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 AdalGenericError : l’opération n’a pas pu être effectué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 Azure Active Directory principal du service de bibliothèque introuvable 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 dans 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 tenté de lancer l’opération qui n’est pas prise en charge lorsque l’instance managée 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 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é avec une autre opération.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo - L’utilisateur a tenté de basculer ou de forcer l’arrêt d’un géo-lien alors que le secondaire est dans un état où il peut ne pas être physiquement cohérent et ne peut donc pas entrer dans 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 pendant qu’une mise à jour SLO était en cours.

  • 409 AzureKeyVaultKeyNameNotFound : l’opération n’a pas pu être terminée, car le nom de 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 des opérations supplémentaires doivent attendre sa fin.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationRelationShip - Une opération d’amorçage de réplication a été effectuée sur une base de données 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 requête en double.

  • 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par des ressources disponibles.

  • 429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par des ressources disponibles.

  • 503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par des ressources disponibles.

  • 503 AzureKeyVaultConnectionFailed : l’opération n’a pas pu être terminé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

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

Sample Response

{
  "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/failoverGroups",
      "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/failoverGroups",
      "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

InstanceFailoverGroup

Un groupe de basculement d’instance.

InstanceFailoverGroupListResult

Liste des groupes de basculement d’instance.

InstanceFailoverGroupReadOnlyEndpoint

Point de terminaison en lecture seule de l’instance de groupe de basculement.

InstanceFailoverGroupReadWriteEndpoint

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

InstanceFailoverGroupReplicationRole

Rôle de réplication local de l’instance de groupe de basculement.

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 est automatique, failoverWithDataLossGracePeriodMinutes est requis.

InstanceFailoverGroup

Un groupe de basculement d’instance.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.managedInstancePairs

Liste des paires d’instances managées dans le groupe de basculement.

properties.partnerRegions

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

properties.readOnlyEndpoint

Point de terminaison en lecture seule de l’instance de groupe de basculement.

properties.readWriteEndpoint

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

properties.replicationRole

Rôle de réplication local de l’instance de groupe de basculement.

properties.replicationState
  • string

État de réplication de l’instance de groupe de basculement.

type
  • string

Type de ressource.

InstanceFailoverGroupListResult

Liste des groupes de basculement d’instance.

Name Type Description
nextLink
  • string

Lien pour récupérer la page suivante des résultats.

value

Tableau de résultats.

InstanceFailoverGroupReadOnlyEndpoint

Point de terminaison en lecture seule de l’instance de groupe de basculement.

Name Type Description
failoverPolicy

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

InstanceFailoverGroupReadWriteEndpoint

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

Name Type Description
failoverPolicy

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

failoverWithDataLossGracePeriodMinutes
  • integer

Période de grâce avant le basculement avec perte de données est tentée pour le point de terminaison en lecture-écriture. Si failoverPolicy est automatique, failoverWithDataLossGracePeriodMinutes est requis.

InstanceFailoverGroupReplicationRole

Rôle de réplication local de l’instance de groupe de basculement.

Name Type Description
Primary
  • string
Secondary
  • string

ManagedInstancePairInfo

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

Name Type Description
partnerManagedInstanceId
  • string

ID du Managed Instance partenaire en paire.

primaryManagedInstanceId
  • string

ID du Managed Instance principal en paire.

PartnerRegionInfo

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

Name Type Description
location
  • string

Emplacement géographique des instances gérées par le partenaire.

replicationRole

Rôle de réplication des instances gérées par le partenaire.

ReadOnlyEndpointFailoverPolicy

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

Name 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, failoverWithDataLossGracePeriodMinutes est requis.

Name Type Description
Automatic
  • string
Manual
  • string