Failover Groups - List By Server

Dienst:: SQL Database

API-Version:: 2025-01-01

Listet die Failovergruppen auf einem Server auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	FailoverGroupListResult	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List failover group

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups?api-version=2025-01-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "failover-group-test",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test",
      "location": "Japan East",
      "properties": {
        "databases": [],
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP"
      }
    },
    {
      "name": "failover-group-test-2",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-2",
      "location": "Japan East",
      "properties": {
        "databases": [],
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FailoverGroup	Eine Failovergruppe.
FailoverGroupDatabasesSecondaryType	Sekundärer Datenbanktyp auf Partnerserver.
FailoverGroupListResult	Die Antwort einer FailoverGroup-Listenoperation.
FailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppeninstanz.
FailoverGroupReadWriteEndpoint	Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
FailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppeninstanz.
PartnerInfo	Partnerserverinformationen für die Failovergruppe.
ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.
ReadWriteEndpointFailoverPolicy	Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FailoverGroup

Objekt

Eine Failovergruppe.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ressourcenspeicherort.
name	string	Der Name der Ressource
properties.databases	string[] (arm-id)	Liste der Datenbanken in der Failovergruppe.
properties.partnerServers	PartnerInfo[]	Liste der Partnerserverinformationen für die Failovergruppe.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppeninstanz.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.
properties.replicationRole	FailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppeninstanz.
properties.replicationState	string	Replikationsstatus der Failovergruppeninstanz.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Sekundärer Datenbanktyp auf Partnerserver.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

FailoverGroupDatabasesSecondaryType

Enumeration

Sekundärer Datenbanktyp auf Partnerserver.

Wert	Beschreibung
Geo	Geo
Standby	Reserve

FailoverGroupListResult

Objekt

Die Antwort einer FailoverGroup-Listenoperation.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	FailoverGroup[]	Die FailoverGroup-Elemente auf dieser Seite

FailoverGroupReadOnlyEndpoint

Objekt

Schreibgeschützter Endpunkt der Failovergruppeninstanz.

Name	Typ	Beschreibung
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.
targetServer	string (arm-id)	Der Zielpartnerserver, auf den der schreibgeschützte Endpunkt verweist.

FailoverGroupReadWriteEndpoint

Objekt

Lese-/Schreibzugriffsendpunkt der Failovergruppeninstanz.

Name	Typ	Beschreibung
failoverPolicy	ReadWriteEndpointFailoverPolicy	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.

FailoverGroupReplicationRole

Enumeration

Lokale Replikationsrolle der Failovergruppeninstanz.

Wert	Beschreibung
Primary	Primär
Secondary	Secondary

PartnerInfo

Objekt

Partnerserverinformationen für die Failovergruppe.

Name	Typ	Beschreibung
id	string (arm-id)	Ressourcenbezeichner des Partnerservers.
location	string	Geografischer Standort des Partnerservers.
replicationRole	FailoverGroupReplicationRole	Replikationsrolle des Partnerservers.

ReadOnlyEndpointFailoverPolicy

Enumeration

Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.

Wert	Beschreibung
Disabled	Deaktiviert
Enabled	Aktiviert

ReadWriteEndpointFailoverPolicy

Enumeration

Failoverrichtlinie des Lese-/Schreibzugriffsendpunkts für die Failovergruppe. Wenn failoverPolicy automatisch ist, ist failoverWithDataLossGracePeriodMinutes erforderlich.

Wert	Beschreibung
Manual	Manuell
Automatic	Automatisch

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Failover Groups - List By Server

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List failover group

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailoverGroup

FailoverGroupDatabasesSecondaryType

FailoverGroupListResult

FailoverGroupReadOnlyEndpoint

FailoverGroupReadWriteEndpoint

FailoverGroupReplicationRole

PartnerInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

systemData