Instance Failover Groups - Get
Obtient un groupe de basculement.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2023-08-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
failover
|
path | True |
string |
Nom du groupe de basculement. |
|
location
|
path | True |
string |
Nom de la région où se trouve la ressource. |
|
resource
|
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. |
|
subscription
|
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 |
Récupération réussie du groupe de basculement spécifié. |
|
| Other Status Codes |
Réponses d’erreur : ***
|
Exemples
Get failover group
Exemple de requête
Exemple de réponse
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
"name": "failover-group-test-3",
"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"
}
],
"secondaryType": "Geo"
}
}
Définitions
| Nom | Description |
|---|---|
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Instance |
Un groupe de basculement d’instance. |
|
Instance |
Point de terminaison en lecture seule de l’instance de groupe de basculement. |
|
Instance |
Point de terminaison en lecture-écriture de l’instance de groupe de basculement. |
|
Instance |
Rôle de réplication local de l’instance de groupe de basculement. |
|
Managed |
Paires d’instances managées dans le groupe de basculement. |
|
Partner |
Informations de région partenaire pour le groupe de basculement. |
|
Read |
Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement. |
|
Read |
Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, basculementWithDataLossGracePeriodMinutes est requis. |
|
Secondary |
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. |
ErrorAdditionalInfo
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
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
InstanceFailoverGroup
Un groupe de basculement d’instance.
| Nom | Type | Description |
|---|---|---|
| id |
string |
ID de ressource. |
| name |
string |
Nom de la ressource. |
| properties.managedInstancePairs |
Liste des paires d’instances managées dans le groupe de basculement. |
|
| properties.partnerRegions |
Informations de région 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. |
| properties.secondaryType |
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. |
|
| type |
string |
Type de ressource. |
InstanceFailoverGroupReadOnlyEndpoint
Point de terminaison en lecture seule de l’instance de groupe de basculement.
| Nom | 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.
| Nom | Type | Description |
|---|---|---|
| failoverPolicy |
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
Rôle de réplication local de l’instance de groupe de basculement.
| Valeur | Description |
|---|---|
| Primary | |
| Secondary |
ManagedInstancePairInfo
Paires d’instances managées dans le groupe de basculement.
| Nom | Type | Description |
|---|---|---|
| partnerManagedInstanceId |
string |
ID de Partner Managed Instance en paire. |
| primaryManagedInstanceId |
string |
ID de l’instance managée principale en paire. |
PartnerRegionInfo
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 |
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.
| Valeur | Description |
|---|---|
| Disabled | |
| Enabled |
ReadWriteEndpointFailoverPolicy
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 | |
| Automatic |
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.
| Valeur | Description |
|---|---|
| Geo | |
| Standby |