Instance Failover Groups - Get
Ruft eine Failovergruppe ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2023-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
failover
|
path | True |
string |
Der Name der Failovergruppe. |
location
|
path | True |
string |
Der Name der Region, in der sich die Ressource befindet. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen. |
subscription
|
path | True |
string |
Die Abonnement-ID, die ein Azure-Abonnement identifiziert. |
api-version
|
query | True |
string |
Die API-Version, die für die Anforderung verwendet werden soll. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die angegebene Failovergruppe wurde erfolgreich abgerufen. |
|
Other Status Codes |
Fehlerantworten: ***
|
Beispiele
Get failover group
Beispielanforderung
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test?api-version=2023-08-01
Beispiel für eine Antwort
{
"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"
}
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
Instance |
Eine Instanzfailovergruppe. |
Instance |
Schreibgeschützter Endpunkt der Failovergruppeninstanz. |
Instance |
Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz. |
Instance |
Lokale Replikationsrolle der Failovergruppeninstanz. |
Managed |
Paare verwalteter Instanzen in der Failovergruppe. |
Partner |
Partnerregionsinformationen für die Failovergruppe. |
Read |
Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe. |
Read |
Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich. |
Secondary |
Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
InstanceFailoverGroup
Eine Instanzfailovergruppe.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
name |
string |
Ressourcenname. |
properties.managedInstancePairs |
Liste der verwalteten Instanzpaare in der Failovergruppe. |
|
properties.partnerRegions |
Partnerregionsinformationen für die Failovergruppe. |
|
properties.readOnlyEndpoint |
Schreibgeschützter Endpunkt der Failovergruppeninstanz. |
|
properties.readWriteEndpoint |
Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz. |
|
properties.replicationRole |
Lokale Replikationsrolle der Failovergruppeninstanz. |
|
properties.replicationState |
string |
Replikationsstatus der Failovergruppeninstanz. |
properties.secondaryType |
Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird. |
|
type |
string |
Ressourcentyp. |
InstanceFailoverGroupReadOnlyEndpoint
Schreibgeschützter Endpunkt der Failovergruppeninstanz.
Name | Typ | Beschreibung |
---|---|---|
failoverPolicy |
Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe. |
InstanceFailoverGroupReadWriteEndpoint
Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
Name | Typ | Beschreibung |
---|---|---|
failoverPolicy |
Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich. |
|
failoverWithDataLossGracePeriodMinutes |
integer (int32) |
Die Karenzzeit vor dem Failover mit Datenverlust wird für den Endpunkt mit Lese-/Schreibzugriff versucht. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich. |
InstanceFailoverGroupReplicationRole
Lokale Replikationsrolle der Failovergruppeninstanz.
Wert | Beschreibung |
---|---|
Primary | |
Secondary |
ManagedInstancePairInfo
Paare verwalteter Instanzen in der Failovergruppe.
Name | Typ | Beschreibung |
---|---|---|
partnerManagedInstanceId |
string |
ID der partnerverwalteten Instanz im Paar. |
primaryManagedInstanceId |
string |
ID der primären verwalteten Instanz im Paar. |
PartnerRegionInfo
Partnerregionsinformationen für die Failovergruppe.
Name | Typ | Beschreibung |
---|---|---|
location |
string |
Geografischer Standort der vom Partner verwalteten Instanzen. |
replicationRole |
Replikationsrolle der vom Partner verwalteten Instanzen. |
ReadOnlyEndpointFailoverPolicy
Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.
Wert | Beschreibung |
---|---|
Disabled | |
Enabled |
ReadWriteEndpointFailoverPolicy
Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.
Wert | Beschreibung |
---|---|
Automatic | |
Manual |
SecondaryInstanceType
Typ der geo-sekundären Instanz. Legen Sie "Standby" fest, wenn die Instanz nur als DR-Option verwendet wird.
Wert | Beschreibung |
---|---|
Geo | |
Standby |