Instance Failover Groups - List By Location

Service:: SQL Database

Version d'API:: 2025-01-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=2025-01-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 minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	InstanceFailoverGroupListResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

List failover group

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
InstanceFailoverGroup	Un groupe de basculement d’instance.
InstanceFailoverGroupListResult	La réponse d’une opération de liste InstanceFailoverGroup.
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 de région 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, basculementWithDataLossGracePeriodMinutes est requis.
SecondaryInstanceType	Type de l’instance géo-secondaire. Définissez « Veille » si l’instance est utilisée en tant qu’option de récupération d’urgence uniquement.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

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

Objet

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

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

InstanceFailoverGroup

Objet

Un groupe de basculement d’instance.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.managedInstancePairs	ManagedInstancePairInfo[]	Liste des paires d’instances managées dans le groupe de basculement.
properties.partnerRegions	PartnerRegionInfo[]	Informations de région partenaire pour le groupe de basculement.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule de l’instance de groupe de basculement.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture de l’instance de groupe de basculement.
properties.replicationRole	InstanceFailoverGroupReplicationRole	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.
properties.secondaryType	SecondaryInstanceType	Type de l’instance géo-secondaire. Définissez « Veille » si l’instance est utilisée en tant qu’option de récupération d’urgence uniquement.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

InstanceFailoverGroupListResult

Objet

La réponse d’une opération de liste InstanceFailoverGroup.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	InstanceFailoverGroup[]	Les éléments InstanceFailoverGroup sur cette page

InstanceFailoverGroupReadOnlyEndpoint

Objet

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

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

InstanceFailoverGroupReadWriteEndpoint

Objet

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

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, basculementWithDataLossGracePeriodMinutes est requis.
failoverWithDataLossGracePeriodMinutes	integer (int32)	La 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, basculementWithDataLossGracePeriodMinutes est requis.

InstanceFailoverGroupReplicationRole

Énumération

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

Valeur	Description
Primary	Primaire
Secondary	Secondaire

ManagedInstancePairInfo

Objet

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

Nom	Type	Description
partnerManagedInstanceId	string	Id de Partner Managed Instance en paire.
primaryManagedInstanceId	string	Identifiant de Primary Managed Instance en paire.

PartnerRegionInfo

Objet

Informations de région partenaire pour le groupe de basculement.

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

ReadOnlyEndpointFailoverPolicy

Énumération

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

Valeur	Description
Disabled	Désactivé
Enabled	Activé

ReadWriteEndpointFailoverPolicy

Énumération

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

Valeur	Description
Manual	Manuel
Automatic	Automatique

SecondaryInstanceType

Énumération

Type de l’instance géo-secondaire. Définissez « Veille » si l’instance est utilisée en tant qu’option de récupération d’urgence uniquement.

Valeur	Description
Geo	Zone géographique
Standby	Standby (Réserve)

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Instance Failover Groups - List By Location

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

List failover group

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupListResult

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData