Instance Failover Groups - List By Location

Service:

SQL Database

API Version:

2021-11-01

Listet die Failovergruppen an einem Standort auf.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
locationName	path	True	string	Der Name der Region, in der sich die Ressource befindet.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	InstanceFailoverGroupListResult	Die Failovergruppen wurden erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary: Das angegebene primäre Feld in der Erstellung oder Aktualisierung instance Anforderungstext der Failovergruppe ist leer oder ungültig. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner: Das angegebene Partnerfeld in create or update instance Failovergruppenanforderungstext ist leer oder ungültig. 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner: Mindestens einer der bereitgestellten Partnerserver ist bereits Teil der instance Failovergruppe. Stellen Sie sicher, dass der primäre Server und alle angegebenen Partnerserver eindeutig sind. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion: Die vom Partner verwaltete instance Region im Anforderungstext der instance Failovergruppe ist leer oder ungültig. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount: Es wird nur eine Partnerregion unterstützt. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount: Es wird nur ein verwaltetes instance Paar unterstützt. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint: Das Feld readWriteEndpoint ist für Erstellungs- oder Aktualisierungsanforderungen erforderlich. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid: Der Anforderungstext instance Failovergruppe zu erstellen oder zu aktualisieren ist leer oder ungültig. 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary: Änderungen an der instance Failovergruppe sind auf einem sekundären Server nicht zulässig. Führen Sie die Anforderung auf dem primären Server aus. 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues : Der Toleranzzeitraumswert für den Endpunkt mit Lese-/Schreibzugriff muss nicht negativ sein. 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues : Der Wert für den Karenzzeitraum für die instance Failovergruppe muss größer oder gleich der mindesten Toleranzperiode in{0} Minuten sein. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields: Die Eigenschaft failoverWithDataLossGracePeriodMinutes muss bereitgestellt werden, wenn failoverrichtlinie Automatic für den Lese-/Schreibendpunkt ausgewählt ist. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy: Das FailoverPolicy-Feld für den Lese-/Schreibendpunkt ist für Erstellungs- oder Aktualisierungsanforderungen erforderlich. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy : Der Wert für die Karenzzeit sollte nicht angegeben werden, wenn die Failoverrichtlinie Manuell für den Lese-/Schreibendpunkt ausgewählt ist. 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified: Der Anforderungstext für instance Failovergruppe sollte die schreibgeschützte Eigenschaft "{0}" nicht ändern. 400 InstanceFailoverGroupFailoverRequestOnPrimary: Die Failoveranforderung sollte auf dem sekundären Server instance Failovergruppe initiiert werden. 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription: Der primäre Server und der Partnerserver der Failovergruppe stammen aus unterschiedlichen Abonnements. Das abonnementübergreifende Abonnement für Server der Failovergruppe ist nicht zulässig. 400 FailoverGroupRegionMismatch: Die in Failovergruppe angegebene Partnerregion muss mit der Region der vom Partner verwalteten instance übereinstimmen. 400 ServerEditionMismatch - Edition muss mit dem primären Server identisch sein, wenn ein Replikatserver erstellt wird. 400 DnsZoneMismatch: Die DNSZone auf dem Partnerserver unterscheidet sich von der DNSZone auf dem Quellserver. Dadurch wird die InstanceFailoverGroup-Funktionalität unterbrochen. 400 InvalidTargetSubregion: Der Zielserver eines nicht lesbaren sekundären Computers befindet sich nicht in einer Azure-Region mit Notfallwiederherstellung. 400 GeoDrInstanceSizeMismatch: Primäre verwaltete instance und vom Partner verwaltete instance verfügen nicht über dieselbe Speichergröße. 400 SecurityAdalPrincipalCertExpiredError: Der Vorgang konnte nicht abgeschlossen werden, weil das Azure Key Vault-Prinzipalzertifikat abgelaufen ist. 400 GeoDrSecondaryInstanceNotEmpty : Sekundär verwaltete instance über Benutzerdatenbanken verfügt. Zum Erstellen einer instance-Failovergruppe muss die sekundäre verwaltete instance leer sein. 400 InstanceFailoverGroupIncorrectNetworkingConfiguration: Die Netzwerkkonfiguration ist falsch. Der Replikationsdatenverkehr des primären Servers kann den sekundären Server nicht erreichen. 400 IncorrectReplicationLinkState: Der Vorgang erwartet, dass sich die Datenbank auf dem Replikationslink in einem erwarteten Zustand befindet. 400 SecurityInvalidAzureKeyVaultRecoveryLevel: Der bereitgestellte Key Vault URI ist ungültig. 400 KeyMaterialNotFoundOnRemoteServer: Der Remoteserver hat keinen Zugriff auf Schlüsselmaterial, das als TDE-Schutzvorrichtung verwendet wird. 400 AzureKeyVaultRsaKeyNotSupported: Der bereitgestellte Schlüsseltresor verwendet nicht unterstützte RSA-Schlüsselgröße oder -Schlüsseltyp. Die unterstützte RSA-Schlüsselgröße ist 2048 oder 3072, und der Schlüsseltyp ist RSA oder RSA-HSM. 400 UnableToResolveRemoteServer: Der Name des Remotepartnerservers konnte aufgrund eines ungültigen Servernamens oder DNS-Konnektivitätsproblemen nicht aufgelöst werden. 400 SameKeyUriNotFoundOnRemoteServer: Auf dem sekundären Server wird nicht das Schlüsselmaterial aus demselben Schlüsseltresor wie die Verschlüsselungsschutzvorrichtung des primären Servers mit aktivierter automatischer Schlüsselrotation verwendet. 400 RemoteDatabaseCopyPermission: Der Benutzer verfügt nicht über ausreichende Berechtigungen zum Erstellen einer Datenbankkopie auf dem angegebenen Server. 400 SameKeyMaterialNotFoundOnRemoteServer: Der sekundäre Server verfügt nicht über das Schlüsselmaterial der Verschlüsselungsschutzvorrichtung des primären Servers. 400 CannotUseReservedDatabaseName: Der Name der reservierten Datenbank kann in diesem Vorgang nicht verwendet werden. 400 InvalidFailoverGroupRegion: Server, die in einer Instanzfailovergruppe angegeben sind, müssen sich in verschiedenen Regionen befinden, um Isolation zu ermöglichen. 400 InstanceFailoverGroupDoesNotExist: Die Failovergruppe ist auf einem Server nicht vorhanden. 400 InstanceFailoverGroupNotSecondary: Das Failover kann nicht vom primären Server in einer instance Failovergruppe initiiert werden. 400 InvalidServerName: Ungültiger Servername angegeben. 400 InvalidIdentifier: Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen. 400 TokenTooLong: Das bereitgestellte Token ist zu lang. 400 AzureKeyVaultKeyDisabled: Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da der Azure Key Vault-Schlüssel deaktiviert ist. 400 AzureKeyVaultInvalidExpirationDate: Der Vorgang konnte nicht abgeschlossen werden, da das Ablaufdatum des Azure Key Vault Schlüssels ungültig ist. 400 SecurityAzureKeyVaultUrlNullOrEmpty: Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault-URI NULL oder leer ist. 400 InvalidSku: Der Benutzer hat eine ungültige SKU angegeben. 400 InvalidAddSecondaryPermission: Der Benutzer verfügt nicht über ausreichende Berechtigungen zum Hinzufügen einer sekundären Instanz auf dem angegebenen Server. 400 ServerNotFound: Der angeforderte Server wurde nicht gefunden. 400 AzureKeyVaultNoServerIdentity: Die Serveridentität ist nicht ordnungsgemäß konfiguriert. 400 AzureKeyVaultInvalidUri: Eine ungültige Antwort von Azure Key Vault. Verwenden Sie einen gültigen Azure Key Vault-URI. 400 AzureKeyVaultMissingPermissions: Dem Server fehlen die erforderlichen Berechtigungen für die Azure Key Vault. 400 SecurityAzureKeyVaultInvalidKeyName: Der Vorgang konnte aufgrund eines ungültigen Serverschlüsselnamens nicht abgeschlossen werden. 400 PlannedFailoverTimedOutForDatabase: Benutzer hat geplanter Failover aufgerufen, timeout, und eine bestimmte Datenbank scheint Blame zu sein. 400 PlannedFailoverTimedOut: Der Benutzer hat geplanter Failover aufgerufen und beim Versuch, den Partnerverwaltungsdienst zu kontaktieren, ein Timeout ausgelöst. 400 AdalGenericError: Der Vorgang konnte nicht abgeschlossen werden, weil ein Azure Active Directory-Fehler aufgetreten ist. 400 GeoReplicationDatabaseNotSecondary: Der Vorgang erwartet, dass die Datenbank ein Replikationsziel ist. 400 AdalServicePrincipalNotFound: Der Vorgang konnte nicht abgeschlossen werden, weil ein Fehler vom Dienstprinzipal der Azure Active Directory-Bibliothek nicht gefunden wurde. 400 AzureKeyVaultMalformedVaultUri: Der bereitgestellte Key Vault URI ist ungültig. 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden. 404 SourceDatabaseNotFound: Die Quelldatenbank ist nicht vorhanden. 404 ServerNotInSubscription: Der angegebene Server ist im angegebenen Abonnement nicht vorhanden. 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 405 UnsupportedReplicationOperation: Für die Datenbank wurde ein nicht unterstützter Replikationsvorgang initiiert. 409 ManagedInstanceHasHybridLink: Der Benutzer hat versucht, einen Vorgang zu initiieren, der nicht unterstützt wird, wenn für verwaltete instance eine Hybridverbindung konfiguriert ist. 409 RemoteDatabaseExists: Der Name der Zieldatenbank ist auf dem Zielserver bereits vorhanden. 409 ConflictingServerOperation: Für den Server wird derzeit ein Vorgang ausgeführt. 409 SubscriptionDisabled: Das Abonnement ist deaktiviert. 409 InstanceFailoverGroupAlreadyExists: Die Failovergruppe ist auf einem bestimmten Server bereits vorhanden. 409 InstanceFailoverGroupBusy: Die InstanzfailoverGroupBusy-Instanzfailovergruppe ist mit einem anderen Vorgang beschäftigt. 409 GeoReplicationCannotBecomePrimaryDuringUndo: Der Benutzer hat versucht, ein Geolink zu failovern oder zu beenden, während sich die sekundäre Verbindung in einem Zustand befindet, in dem sie möglicherweise nicht physisch konsistent ist und daher nicht in die primäre Rolle wechseln kann. 409 InstanceFailoverGroupDnsRecordInUse: Für den angeforderten Endpunkt ist ein doppelter DNS-Eintrag vorhanden. 409 ServerKeyNameAlreadyExists: Der Serverschlüssel ist bereits auf dem Server vorhanden. 409 ServerKeyUriAlreadyExists: Der Serverschlüssel-URI ist bereits auf dem Server vorhanden. 409 ServerKeyDoesNotExists: Der Serverschlüssel ist nicht vorhanden. 409 InvalidFailoverGroupName: Ungültiger Name der Instanzfailovergroup wurde angegeben. 409 UpdateSloInProgress: Der Benutzer hat versucht, einen inkompatiblen Vorgang zu initiieren, während ein SLO-Update ausgeführt wurde. 409 AzureKeyVaultKeyNameNotFound: Der Vorgang konnte nicht abgeschlossen werden, da der Azure Key Vault Schlüsselname nicht vorhanden ist. 409 AzureKeyVaultKeyInUse: Der Schlüssel wird derzeit vom Server verwendet. 409 ConflictingSystemOperationInProgress: Ein Systemwartungsvorgang für die Datenbank wird ausgeführt, und weitere Vorgänge müssen warten, bis er abgeschlossen ist. 409 InvalidOperationForDatabaseNotInReplicationRelationship: Für eine Datenbank, die sich bereits in einer Replikationsbeziehung befindet, wurde ein Seedingvorgang für die Replikation ausgeführt. 409 InvalidDatabaseStateForOperation: Der Vorgang ist in der Datenbank im aktuellen Replikationszustand nicht zulässig. 409 DuplicateGeoDrRelation: Die Datenbanken befinden sich bereits in einer Replikationsbeziehung. Dies ist eine doppelte Anforderung. 429 SubscriptionTooManyCreateUpdateRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 503 TooManyRequests: Anforderungen, die über die maximale Anzahl von Anforderungen hinausgehen, die von verfügbaren Ressourcen verarbeitet werden können. 503 AzureKeyVaultConnectionFailed: Der Vorgang konnte auf dem Server nicht abgeschlossen werden, da versuche, eine Verbindung mit Azure Key Vault herzustellen, fehlgeschlagen sind. 503 AzureKeyVaultGenericConnectionError: Der Vorgang konnte nicht abgeschlossen werden, da beim Versuch, Key Vault Informationen abzurufen, ein Fehler aufgetreten ist. 504 RequestTimeout: Die Dienstanforderung hat das zulässige Timeout überschritten.

Beispiele

List failover group

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for InstanceFailoverGroups ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/InstanceFailoverGroupList.json
     */
    /**
     * Sample code: List failover group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getInstanceFailoverGroups().listByLocation("Default", "Japan East",
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "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"
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
InstanceFailoverGroup	Eine instance-Failovergruppe.
InstanceFailoverGroupListResult	Eine Liste der instance Failovergruppen.
InstanceFailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppe instance.
InstanceFailoverGroupReadWriteEndpoint	Lese-/Schreibendpunkt der Failovergruppe instance.
InstanceFailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppe instance.
ManagedInstancePairInfo	Paare von verwalteten Instanzen in der Failovergruppe.
PartnerRegionInfo	Partnerregionsinformationen für die Failovergruppe.
ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.
ReadWriteEndpointFailoverPolicy	Failoverrichtlinie des Lese-/Schreibendpunkts für die Failovergruppe. Wenn failoverPolicy den Wert Automatic hat, ist failoverWithDataLossGracePeriodMinutes erforderlich.

InstanceFailoverGroup

Eine instance-Failovergruppe.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.managedInstancePairs	ManagedInstancePairInfo[]	Liste der verwalteten instance-Paare in der Failovergruppe.
properties.partnerRegions	PartnerRegionInfo[]	Partnerregionsinformationen für die Failovergruppe.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Schreibgeschützter Endpunkt der Failovergruppe instance.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Lese-/Schreibendpunkt der Failovergruppe instance.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Lokale Replikationsrolle der Failovergruppe instance.
properties.replicationState	string	Replikationsstatus der Failovergruppe instance.
type	string	Der Ressourcentyp.

InstanceFailoverGroupListResult

Eine Liste der instance Failovergruppen.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Ergebnisseite.
value	InstanceFailoverGroup[]	Array von Ergebnissen.

InstanceFailoverGroupReadOnlyEndpoint

Schreibgeschützter Endpunkt der Failovergruppe instance.

Name	Typ	Beschreibung
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Failoverrichtlinie des schreibgeschützten Endpunkts für die Failovergruppe.

InstanceFailoverGroupReadWriteEndpoint

Lese-/Schreibendpunkt der Failovergruppe instance.

Name	Typ	Beschreibung
failoverPolicy	ReadWriteEndpointFailoverPolicy	Failoverrichtlinie des Lese-/Schreibendpunkts für die Failovergruppe. Wenn failoverPolicy den Wert Automatic hat, ist failoverWithDataLossGracePeriodMinutes erforderlich.
failoverWithDataLossGracePeriodMinutes	integer	Karenzzeit, bevor ein Failover mit Datenverlust für den Endpunkt mit Lese-/Schreibzugriff versucht wird. Wenn failoverPolicy den Wert Automatic hat, ist failoverWithDataLossGracePeriodMinutes erforderlich.

InstanceFailoverGroupReplicationRole

Lokale Replikationsrolle der Failovergruppe instance.

Name	Typ	Beschreibung
Primary	string
Secondary	string

ManagedInstancePairInfo

Paare von verwalteten Instanzen in der Failovergruppe.

Name	Typ	Beschreibung
partnerManagedInstanceId	string	Id des Partner-verwaltete Instanz paarweise.
primaryManagedInstanceId	string	Id der primären verwaltete Instanz paarweise.

PartnerRegionInfo

Partnerregionsinformationen für die Failovergruppe.

Name	Typ	Beschreibung
location	string	Geografischer Standort der vom Partner verwalteten Instanzen.
replicationRole	InstanceFailoverGroupReplicationRole	Replikationsrolle der vom Partner verwalteten Instanzen.

ReadOnlyEndpointFailoverPolicy

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

Name	Typ	Beschreibung
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

Failoverrichtlinie des Lese-/Schreibendpunkts für die Failovergruppe. Wenn failoverPolicy den Wert Automatic hat, ist failoverWithDataLossGracePeriodMinutes erforderlich.

Name	Typ	Beschreibung
Automatic	string
Manual	string