Instance Failover Groups - List By Location
Geeft een lijst weer van de failovergroepen op een locatie.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2023-08-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
location
|
path | True |
string |
De naam van de regio waar de resource zich bevindt. |
|
resource
|
path | True |
string |
De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal. |
|
subscription
|
path | True |
string |
De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd. |
|
api-version
|
query | True |
string |
De API-versie die moet worden gebruikt voor de aanvraag. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De failovergroepen zijn opgehaald. |
|
| Other Status Codes |
Foutreacties: ***
|
Voorbeelden
List failover group
Voorbeeldaanvraag
Voorbeeldrespons
{
"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"
}
],
"secondaryType": "Geo"
}
},
{
"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"
}
],
"secondaryType": "Geo"
}
}
]
}
Definities
| Name | Description |
|---|---|
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
Instance |
Een exemplaarfailovergroep. |
|
Instance |
Een lijst met exemplaarfailovergroepen. |
|
Instance |
Alleen-lezeneindpunt van het exemplaar van de failovergroep. |
|
Instance |
Lees-schrijfeindpunt van het exemplaar van de failovergroep. |
|
Instance |
Lokale replicatierol van het exemplaar van de failovergroep. |
|
Managed |
Paren van beheerde exemplaren in de failovergroep. |
|
Partner |
Informatie over de partnerregio voor de failovergroep. |
|
Read |
Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep. |
|
Read |
Failoverbeleid van het eindpunt lezen/schrijven voor de failovergroep. Als failoverPolicy Automatisch is, is failoverWithDataLossGracePeriodMinutes vereist. |
|
Secondary |
Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
object |
De aanvullende informatie. |
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
InstanceFailoverGroup
Een exemplaarfailovergroep.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource-id. |
| name |
string |
Resourcenaam. |
| properties.managedInstancePairs |
Lijst met beheerde exemplaarparen in de failovergroep. |
|
| properties.partnerRegions |
Informatie over de partnerregio voor de failovergroep. |
|
| properties.readOnlyEndpoint |
Alleen-lezeneindpunt van het exemplaar van de failovergroep. |
|
| properties.readWriteEndpoint |
Lees-schrijfeindpunt van het exemplaar van de failovergroep. |
|
| properties.replicationRole |
Lokale replicatierol van het exemplaar van de failovergroep. |
|
| properties.replicationState |
string |
Replicatiestatus van het exemplaar van de failovergroep. |
| properties.secondaryType |
Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt. |
|
| type |
string |
Resourcetype. |
InstanceFailoverGroupListResult
Een lijst met exemplaarfailovergroepen.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
Koppeling om de volgende pagina met resultaten op te halen. |
| value |
Matrix met resultaten. |
InstanceFailoverGroupReadOnlyEndpoint
Alleen-lezeneindpunt van het exemplaar van de failovergroep.
| Name | Type | Description |
|---|---|---|
| failoverPolicy |
Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep. |
InstanceFailoverGroupReadWriteEndpoint
Lees-schrijfeindpunt van het exemplaar van de failovergroep.
| Name | Type | Description |
|---|---|---|
| failoverPolicy |
Failoverbeleid van het eindpunt lezen/schrijven voor de failovergroep. Als failoverPolicy Automatisch is, is failoverWithDataLossGracePeriodMinutes vereist. |
|
| failoverWithDataLossGracePeriodMinutes |
integer (int32) |
Respijtperiode voordat een failover met gegevensverlies wordt uitgevoerd voor het eindpunt voor lezen/schrijven. Als failoverPolicy Automatisch is, is failoverWithDataLossGracePeriodMinutes vereist. |
InstanceFailoverGroupReplicationRole
Lokale replicatierol van het exemplaar van de failovergroep.
| Waarde | Description |
|---|---|
| Primary | |
| Secondary |
ManagedInstancePairInfo
Paren van beheerde exemplaren in de failovergroep.
| Name | Type | Description |
|---|---|---|
| partnerManagedInstanceId |
string |
Id van partnerbeheerexemplaren in combinatie. |
| primaryManagedInstanceId |
string |
Id van primair beheerd exemplaar in combinatie. |
PartnerRegionInfo
Informatie over de partnerregio voor de failovergroep.
| Name | Type | Description |
|---|---|---|
| location |
string |
Geografische locatie van de beheerde exemplaren van de partner. |
| replicationRole |
Replicatierol van de door de partner beheerde exemplaren. |
ReadOnlyEndpointFailoverPolicy
Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep.
| Waarde | Description |
|---|---|
| Disabled | |
| Enabled |
ReadWriteEndpointFailoverPolicy
Failoverbeleid van het eindpunt lezen/schrijven voor de failovergroep. Als failoverPolicy Automatisch is, is failoverWithDataLossGracePeriodMinutes vereist.
| Waarde | Description |
|---|---|
| Manual | |
| Automatic |
SecondaryInstanceType
Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt.
| Waarde | Description |
|---|---|
| Geo | |
| Standby |