Delen via


Failover Groups - Get

Hiermee haalt u een failovergroep op.

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

URI-parameters

Name In Vereist Type Description
failoverGroupName
path True

string

De naam van de failovergroep.

resourceGroupName
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.

serverName
path True

string

De naam van de server die de failovergroep bevat.

subscriptionId
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

FailoverGroup

De opgegeven failovergroep is opgehaald.

Other Status Codes

ErrorResponse

Foutreacties: ***

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases: de opgegeven database-id's zijn niet juist samengestelde databaseresource-id's. Zie https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate voor het voorbeeld van de juiste opmaak

  • 400 FailoverGroupCreateOrUpdateRequestInvalidPartner: het veld opgegeven partners in de aanvraagbody voor het maken of bijwerken van een failovergroep is leeg of ongeldig. Geef een geldige waarde van dit veld op. Zie https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate voor voorbeelden van correct opgemaakte aanvragen

  • 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner: een of meer van de opgegeven partnerservers maken al deel uit van de failovergroep. Zorg ervoor dat de primaire server en alle opgegeven partnerservers uniek zijn.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer: een of meer van de opgegeven databases bestaan niet op de primaire server van de failovergroep. Zorg ervoor dat alle databases op de primaire server aanwezig zijn.

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount : slechts één partnerserver voor failovergroep wordt ondersteund. Wijzig uw aanvraag dienovereenkomstig. Zie https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate voor voorbeelden van geldige aanvragen

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint : het veld readWriteEndpoint is vereist voor het maken of bijwerken van aanvragen.

  • 400 FailoverGroupCreateOrUpdateRequestInvalid: de aanvraagbody voor het maken of bijwerken van een failovergroep is leeg of ongeldig.

  • 400 FailoverGroupUpdateOrDeleteRequestOnSecondary: wijzigingen in de failovergroep zijn niet toegestaan op een secundaire server. Voer de aanvraag uit op de primaire server.

  • 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues: respijtperiodewaarde voor het eindpunt voor lezen/schrijven moet niet negatief zijn.

  • 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues - Respijtperiodewaarde voor de failovergroep moet groter zijn dan of gelijk zijn aan de minimale respijtperiode van '{0}' minuten

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - De eigenschapfailoverWithDataLossGracePeriodMinutes moet worden opgegeven wanneer failoverbeleid Automatisch is geselecteerd voor het eindpunt lezen/schrijven.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy : het veld failoverPolicy voor het eindpunt lezen/schrijven is vereist voor het maken of bijwerken van aanvragen.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Respijtperiodewaarde mag niet worden opgegeven wanneer failoverbeleid Handmatig is geselecteerd voor het eindpunt lezen/schrijven. Verwijder het uit de aanvraag.

  • 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified: de aanvraagbody voor het maken of bijwerken van een failovergroep mag de alleen-lezen eigenschap '{0}' niet wijzigen.

  • 400 FailoverGroupFailoverRequestOnPrimary : de failoveraanvraag moet worden gestart op de secundaire server van de failovergroep.

  • 400 FailoverGroupPartnerServerFromDifferentSubscription - Primaire server en de partnerservers van de failovergroep zijn afkomstig uit verschillende abonnementen. Kruisabonnement voor servers van failovergroep is niet toegestaan.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadOnlyEndpointTargetServer: de eigenschap targetServer van het alleen-lezen eindpunt moet een geldige server zijn die aanwezig is onder de partnerservers die zijn geconfigureerd voor de failovergroep.

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCountForStandby - Er wordt slechts één partnerserver voor failovergroep ondersteund voor secondaryType stand-by. Wijzig uw aanvraag dienovereenkomstig.

  • 400 InvalidAddSecondaryPermission - Gebruiker heeft onvoldoende machtigingen om secundair toe te voegen op de opgegeven server.

  • 400 InvalidSku: de gebruiker heeft een ongeldige SKU opgegeven.

  • 400 ServerNotFound - De aangevraagde server is niet gevonden.

  • 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie.

  • 400 TokenTooLong - Het opgegeven token is te lang.

  • 400 InvalidTargetSubregion: de doelserver van een niet-leesbare secundaire server bevindt zich niet in een gekoppelde Azure-regio met herstel na noodgeval.

  • 400 PartnerServerNotCompatible : de gebruiker probeert een database van een SAWA V1-server te kopiëren naar een Sterling-server of omgekeerd.

  • 400 IncorrectReplicationLinkState: de bewerking verwacht dat de database een verwachte status heeft op de replicatiekoppeling.

  • 400 ResourcePoolNotFound - Opgegeven elastische pool bestaat niet op de opgegeven logische server.

  • 400 AzureKeyVaultKeyDisabled: de bewerking kan niet worden voltooid op de server omdat de Azure Key Vault-sleutel is uitgeschakeld.

  • 400 AzureKeyVaultInvalidExpirationDate: de bewerking kan niet worden voltooid omdat de vervaldatum van de Azure Key Vault-sleutel ongeldig is.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty: de bewerking kan niet worden voltooid omdat de Azure Key Vault-URI null of leeg is.

  • 400 AzureKeyVaultNoServerIdentity: de serveridentiteit is niet juist geconfigureerd.

  • 400 AzureKeyVaultInvalidUri: een ongeldig antwoord van Azure Key Vault. Gebruik een geldige Azure Key Vault-URI.

  • 400 AzureKeyVaultMissingPermissions: de server mist vereiste machtigingen voor de Azure Key Vault.

  • 400 SecurityAzureKeyVaultInvalidKeyName : de bewerking kan niet worden voltooid vanwege een ongeldige serversleutelnaam.

  • 400 PlannedFailoverTimedOutForDatabase : gebruiker heeft een geplande failover aangeroepen, er is een time-out opgetreden en een specifieke database lijkt de schuld te zijn.

  • 400 PlannedFailoverTimedOut - Gebruiker heeft een geplande failover aangeroepen en er is een time-out opgetreden tijdens het contact opnemen met de partnerbeheerservice.

  • 400 AdalGenericError: de bewerking kan niet worden voltooid omdat er een Azure Active Directory-fout is opgetreden.

  • 400 AdalServicePrincipalNotFound : de bewerking kan niet worden voltooid omdat er geen service-principal voor de Azure Active Directory-bibliotheek is gevonden.

  • 400 AzureKeyVaultMalformedVaultUri: de opgegeven Key Vault-URI is niet geldig.

  • 400 CannotUseReservedDatabaseName - Kan in deze bewerking geen gereserveerde databasenaam gebruiken.

  • 400 InvalidFailoverGroupRegion - Servers die zijn opgegeven in een failovergroep moeten zich in verschillende regio's bevinden om isolatie te bieden.

  • 400 FailoverGroupDoesNotExist - Failovergroep bestaat niet op een server.

  • 400 FailoverGroupNotSecondary - Failover kan niet worden gestart vanaf de primaire server in een failovergroep.

  • 400 InvalidServerName - Ongeldige servernaam opgegeven.

  • 400 DatabaseInFailoverGroupNotPrimary - GeoDR-koppeling voor de database bestaat al, maar de rol is niet Primair of is geen continue kopieerkoppeling.

  • 400 SecurityAdalPrincipalCertExpiredError: de bewerking kan niet worden voltooid omdat het Azure Key Vault-principalcertificaat is verlopen.

  • 400 UnableToCreateFailoverGroupDueToTableAuditing : failovergroep kan niet worden gemaakt voor de server waarvoor tabelcontrole is ingeschakeld.

  • 400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken.

  • 400 UnableToAddDbWithTableAuditingToFailoverGroup - Database waarvoor Tabelcontrole is ingeschakeld, is niet toegankelijk via failovergroepeindpunt.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel- De opgegeven Key Vault-URI is niet geldig.

  • 400 KeyMaterialNotFoundOnRemoteServer - Externe server heeft geen toegang tot sleutelmateriaal dat wordt gebruikt als een TDE-beveiliging.

  • 400 LimitOfFailoverGroupsPerServerExceeded: het maken van een nieuwe failovergroep overschrijdt het toegestane aantal failovergroepen per server.

  • 400 SameKeyUriNotFoundOnRemoteServer - Secundaire server beschikt niet over het sleutelmateriaal uit dezelfde sleutelkluis als de versleutelingsbeveiliging van de primaire server waarvoor automatische rotatie van sleutels is ingeschakeld.

  • 400 AzureKeyVaultRsaKeyNotSupported: de opgegeven sleutelkluis maakt gebruik van niet-ondersteunde RSA-sleutelgrootte of sleuteltype. De ondersteunde RSA-sleutelgrootte is 2048 of 3072 en sleuteltype is RSA of RSA-HSM.

  • 400 SameKeyMaterialNotFoundOnRemoteServer - Secundaire server beschikt niet over het sleutelmateriaal van de versleutelingsbeveiliging van de primaire server.

  • 400 GeoReplicationDatabaseNotSecondary : de bewerking verwacht dat de database een replicatiedoel is.

  • 400 GeoReplicaLimitReached : de replicatielimiet per replica is bereikt.

  • 400 FailoverGroupWithVirtualNetworkRulesNotSupported - Failovergroepen geconfigureerd met een beleid voor automatische failover worden momenteel niet ondersteund op servers die zijn geconfigureerd met firewallregels voor virtuele netwerken. Configureer de failovergroep met handmatig failoverbeleid.

  • 400 UnableToResolveRemoteServer : de naam van de externe partnerserver kan niet worden omgezet vanwege een ongeldige servernaam of DNS-verbindingsproblemen.

  • 400 RemoteDatabaseCopyPermission - Gebruiker beschikt niet over voldoende machtigingen om een databasekopie te maken op de opgegeven server.

  • 400 SecurityAzureKeyVaultGeoChainError: het maken van een secundaire waarde (een proces dat ook wel ketening wordt genoemd) wordt niet ondersteund bij het inschakelen van Transparent Data Encryption met behulp van Azure Key Vault (BYOK).

  • 404 ResourceNotFound : de aangevraagde resource is niet gevonden.

  • 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 ServerNotInSubscription : de opgegeven server bestaat niet in het opgegeven abonnement.

  • 404 SourceDatabaseNotFound - De brondatabase bestaat niet.

  • 405 UnsupportedReplicationOperation - Er is een niet-ondersteunde replicatiebewerking gestart op de database.

  • 409 ConflictingServerOperation: er wordt momenteel een bewerking uitgevoerd voor de server.

  • 409 SubscriptionDisabled - Abonnement is uitgeschakeld.

  • 409 ConflictingSystemOperationInProgress: er wordt een systeemonderhoudsbewerking uitgevoerd op de database en verdere bewerkingen moeten wachten totdat deze is voltooid.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo - Gebruiker heeft geprobeerd een geo-link uit te voeren of een geo-link af te sluiten, terwijl de secundaire zich in een toestand bevindt waarin deze mogelijk niet fysiek consistent is en dus de primaire rol niet kan invoeren.

  • 409 ServerKeyNameAlreadyExists : de serversleutel bestaat al op de server.

  • 409 ServerKeyUriAlreadyExists - De serversleutel-URI bestaat al op de server.

  • 409 ServerKeyDoesNotExists - De serversleutel bestaat niet.

  • 409 UpdateSloInProgress - Gebruiker heeft geprobeerd een incompatibele bewerking te starten terwijl er een SLO-update werd uitgevoerd.

  • 409 AzureKeyVaultKeyNameNotFound: de bewerking kan niet worden voltooid omdat de Azure Key Vault-sleutelnaam niet bestaat.

  • 409 AzureKeyVaultKeyInUse: de sleutel wordt momenteel gebruikt door de server.

  • 409 FailoverGroupAlreadyExists - Failovergroep bestaat al op een bepaalde server. Gebruik een andere naam van de failovergroep.

  • 409 FailoverGroupBusy : failovergroep is bezig met een andere bewerking.

  • 409 DatabaseBelongsToOtherFailoverGroup - Database behoort tot een andere failovergroep en kan geen deel uitmaken van deze.

  • 409 DatabaseBeingAddedToFailoverGroup : de database wordt momenteel toegevoegd aan de failovergroep. De klant moet wachten tot deze bewerking is voltooid om het verwijderen uit te voeren.

  • 409 DatabaseBeingRemovedFromFailoverGroup : de database wordt momenteel verwijderd uit de failovergroep. De klant moet wachten tot deze bewerking is voltooid om het probleem toe te voegen.

  • 409 FailoverGroupDnsRecordInUse: er bestaat een dubbele DNS-record voor het aangevraagde eindpunt.

  • 409 InvalidFailoverGroupName - Ongeldige naam van failovergroep is opgegeven.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship - Er is een replicatiebewerking uitgevoerd op een database die zich niet in een replicatierelatie bevindt.

  • 409 InvalidDatabaseStateForOperation: de bewerking is niet toegestaan voor de database met de huidige replicatiestatus.

  • 409 DuplicateGeoDrRelation: de databases bevinden zich al in een replicatierelatie. Dit is een dubbele aanvraag.

  • 409 RemoteDatabaseExists : de naam van de doeldatabase bestaat al op de doelserver.

  • 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

  • 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

  • 503 AzureKeyVaultConnectionFailed : de bewerking kan niet worden voltooid op de server omdat pogingen om verbinding te maken met Azure Key Vault zijn mislukt

  • 503 AzureKeyVaultGenericConnectionError : de bewerking kan niet worden voltooid omdat er een fout is opgetreden bij het ophalen van Key Vault-gegevens.

  • 503 DatabaseUnavailable - De bewerking is mislukt omdat de database niet beschikbaar is.

  • 504 RequestTimeout - Serviceaanvraag heeft de toegestane time-out overschreden.

Voorbeelden

Get failover group

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/failoverGroups/failovergrouptest3?api-version=2023-08-01

Voorbeeldrespons

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/failoverGroups/failovergrouptest3",
  "name": "failovergrouptest3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "location": "Japan West",
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "readOnlyEndpoint": {
      "failoverPolicy": "Enabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver"
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver",
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb2"
    ]
  }
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

FailoverGroup

Een failovergroep.

FailoverGroupDatabasesSecondaryType

Het secundaire type databases op de partnerserver.

FailoverGroupReadOnlyEndpoint

Alleen-lezeneindpunt van het exemplaar van de failovergroep.

FailoverGroupReadWriteEndpoint

Lees-schrijfeindpunt van het exemplaar van de failovergroep.

FailoverGroupReplicationRole

Lokale replicatierol van het exemplaar van de failovergroep.

PartnerInfo

Informatie over de partnerserver voor de failovergroep.

ReadOnlyEndpointFailoverPolicy

Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep.

ReadWriteEndpointFailoverPolicy

Failoverbeleid van het eindpunt lezen/schrijven voor de failovergroep. Als failoverPolicy Automatisch is, is failoverWithDataLossGracePeriodMinutes vereist.

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

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

FailoverGroup

Een failovergroep.

Name Type Description
id

string

Resource-id.

location

string

Resourcelocatie.

name

string

Resourcenaam.

properties.databases

string[] (arm-id)

Lijst met databases in de failovergroep.

properties.partnerServers

PartnerInfo[]

Lijst met partnerservergegevens voor de failovergroep.

properties.readOnlyEndpoint

FailoverGroupReadOnlyEndpoint

Alleen-lezeneindpunt van het exemplaar van de failovergroep.

properties.readWriteEndpoint

FailoverGroupReadWriteEndpoint

Lees-schrijfeindpunt van het exemplaar van de failovergroep.

properties.replicationRole

FailoverGroupReplicationRole

Lokale replicatierol van het exemplaar van de failovergroep.

properties.replicationState

string

Replicatiestatus van het exemplaar van de failovergroep.

properties.secondaryType

FailoverGroupDatabasesSecondaryType

Het secundaire type databases op de partnerserver.

tags

object

Resourcetags.

type

string

Resourcetype.

FailoverGroupDatabasesSecondaryType

Het secundaire type databases op de partnerserver.

Waarde Description
Geo
Standby

FailoverGroupReadOnlyEndpoint

Alleen-lezeneindpunt van het exemplaar van de failovergroep.

Name Type Description
failoverPolicy

ReadOnlyEndpointFailoverPolicy

Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep.

targetServer

string (arm-id)

De doelpartnerserver waarnaar het eindpunt alleen-lezen verwijst.

FailoverGroupReadWriteEndpoint

Lees-schrijfeindpunt van het exemplaar van de failovergroep.

Name Type Description
failoverPolicy

ReadWriteEndpointFailoverPolicy

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.

FailoverGroupReplicationRole

Lokale replicatierol van het exemplaar van de failovergroep.

Waarde Description
Primary
Secondary

PartnerInfo

Informatie over de partnerserver voor de failovergroep.

Name Type Description
id

string (arm-id)

Resource-id van de partnerserver.

location

string

Geografische locatie van de partnerserver.

replicationRole

FailoverGroupReplicationRole

Replicatiefunctie van de partnerserver.

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
Automatic
Manual