Instance Failover Groups - Get

Hämtar en redundansgrupp.

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

URI-parametrar

Name I Obligatorisk Typ Description
failoverGroupName
path True

string

Namnet på redundansgruppen.

locationName
path True

string

Namnet på den region där resursen finns.

resourceGroupName
path True

string

Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.

subscriptionId
path True

string

Prenumerations-ID:t som identifierar en Azure-prenumeration.

api-version
query True

string

DEN API-version som ska användas för begäran.

Svar

Name Typ Description
200 OK

InstanceFailoverGroup

Den angivna redundansgruppen har hämtats.

Other Status Codes

Felsvar: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary – Det angivna primära fältet i begärandetexten för att skapa eller uppdatera en instans av en redundansgrupp är tom eller ogiltig.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner – det angivna partnerfältet i begärandetexten för att skapa eller uppdatera instansens redundansgrupp är tomt eller ogiltigt.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner – en eller flera av de angivna partnerservrarna ingår redan i redundansgruppen för instanser. Kontrollera att den primära servern och alla angivna partnerservrar är unika.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion – den tillhandahållna partnerhanterade instansregionen i begärandetexten för instansens redundansgrupp är tom eller ogiltig.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount – endast en partnerregion stöds.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount – endast ett hanterat instanspar stöds.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint – fältet readWriteEndpoint krävs för begäranden om att skapa eller uppdatera.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid – Begärandetexten för att skapa eller uppdatera en instans av en redundansgrupp är tom eller ogiltig.

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary – Ändringar i instansens redundansgrupp tillåts inte på en sekundär server. Kör begäran på den primära servern.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues – Respitperiodvärdet för läs- och skrivslutpunkten måste vara icke-negativt.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues – Respitperiodvärdet för redundansgruppen för instansen måste vara större än eller lika med minsta respitperiod för minuter{0}

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields – Egenskapen failoverWithDataLossGracePeriodMinutes måste anges när principen automatisk redundans har valts för läs- och skrivslutpunkten.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy – fältet failoverPolicy för läs- och skrivslutpunkten krävs för att skapa eller uppdatera begäranden.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy – Respitperiodvärde ska inte anges när redundansprincip manuell har valts för läs-/skrivslutpunkten.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified – Begärandetexten för att skapa eller uppdatera instansens redundansgrupp bör inte ändra den skrivskyddade egenskapen .{0}

  • 400 InstanceFailoverGroupFailoverRequestOnPrimary – Redundansbegäran ska initieras på den sekundära servern för instansens redundansgrupp.

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription – Den primära servern och partnerservern för redundansgruppen kommer från olika prenumerationer. Korsprenumeration för servrar i redundansgrupper tillåts inte.

  • 400 FailoverGroupRegionMismatch – Partnerregion som anges i redundansgruppen måste matcha regionen för den partnerhanterade instans som anges.

  • 400 ServerEditionMismatch – Utgåvan måste vara samma som den primära servern när du skapar en replikserver.

  • 400 DnsZoneMismatch – DNSZone på partnerservern skiljer sig från DNSZone på källservern. Detta bryter funktionerna i InstanceFailoverGroup.

  • 400 InvalidTargetSubregion – Målservern för en icke läsbar sekundär är inte i en DR-länkad Azure-region.

  • 400 GeoDrInstanceSizeMismatch – Den primära hanterade instansen och den partnerhanterade instansen har inte samma lagringsstorlek.

  • 400 SecurityAdalPrincipalCertExpiredError – Åtgärden kunde inte slutföras eftersom Azure Key Vault huvudcertifikatet har upphört att gälla.

  • 400 GeoDrSecondaryInstanceNotEmpty – Den sekundära hanterade instansen har användardatabaser. Om du vill skapa en instansredundansgrupp måste den sekundära hanterade instansen vara tom.

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration – Nätverkskonfigurationen är felaktig. Den primära serverns replikeringstrafik kan inte nå den sekundära servern.

  • 400 IncorrectReplicationLinkState – Åtgärden förväntar sig att databasen är i ett förväntat tillstånd på replikeringslänken.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel – den angivna Key Vault URI är inte giltig.

  • 400 KeyMaterialNotFoundOnRemoteServer – Fjärrservern har inte åtkomst till nyckelmaterial som används som TDE-skydd.

  • 400 AzureKeyVaultRsaKeyNotSupported – Det angivna nyckelvalvet använder RSA-nyckelstorlek eller nyckeltyp som inte stöds. Den RSA-nyckelstorlek som stöds är 2048 eller 3072 och nyckeltypen är RSA eller RSA-HSM.

  • 400 UnableToResolveRemoteServer – Det gick inte att lösa namnet på fjärrpartnerservern på grund av ett ogiltigt servernamn eller dns-anslutningsproblem.

  • 400 SameKeyUriNotFoundOnRemoteServer – Den sekundära servern har inte nyckelmaterialet från samma nyckelvalv som den primära serverns krypteringsskydd med automatisk nyckelrotation aktiverat.

  • 400 RemoteDatabaseCopyPermission – Användaren har inte tillräcklig behörighet för att skapa en databaskopia på den angivna servern.

  • 400 SameKeyMaterialNotFoundOnRemoteServer – den sekundära servern har inte nyckelmaterialet för den primära serverns krypteringsskydd.

  • 400 CannotUseReservedDatabaseName – Det går inte att använda reserverade databasnamn i den här åtgärden.

  • 400 InvalidFailoverGroupRegion – Servrar som anges i en redundansgrupp för instanser måste finnas i olika regioner för att tillhandahålla isolering.

  • 400 InstanceFailoverGroupDoesNotExist – Redundansgruppen finns inte på en server.

  • 400 InstanceFailoverGroupNotSecondary – Redundans kan inte initieras från den primära servern i en redundansgrupp för instanser.

  • 400 InvalidServerName – Ogiltigt servernamn har angetts.

  • 400 InvalidIdentifier – identifieraren innehåller NULL eller ett ogiltigt unicode-tecken.

  • 400 TokenTooLong – den angivna token är för lång.

  • 400 AzureKeyVaultKeyDisabled – Det gick inte att slutföra åtgärden på servern eftersom Azure Key Vault-nyckeln är inaktiverad.

  • 400 AzureKeyVaultInvalidExpirationDate – Det gick inte att slutföra åtgärden eftersom förfallodatumet för Azure Key Vault-nyckeln är ogiltigt.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – Åtgärden kunde inte slutföras eftersom Azure Key Vault URI är null eller tom.

  • 400 InvalidSku – Användaren har angett en ogiltig SKU.

  • 400 InvalidAddSecondaryPermission – Användaren har inte tillräcklig behörighet för att lägga till sekundär på den angivna servern.

  • 400 ServerNotFound – Den begärda servern hittades inte.

  • 400 AzureKeyVaultNoServerIdentity – serveridentiteten är inte korrekt konfigurerad.

  • 400 AzureKeyVaultInvalidUri – ett ogiltigt svar från Azure Key Vault. Använd en giltig URI för Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions – servern saknar nödvändiga behörigheter för Azure-Key Vault.

  • 400 SecurityAzureKeyVaultInvalidKeyName – Det gick inte att slutföra åtgärden på grund av ett ogiltigt servernyckelnamn.

  • 400 PlannedFailoverTimedOutForDatabase – Användaren anropade planerad felövergång, tidsgränsen uppnåddes och en specifik databas verkar vara skyldig.

  • 400 PlannedFailoverTimedOut – Användaren anropade planerad felövergång och tidsgränsen uppnåddes vid försök att kontakta partnerhanteringstjänsten.

  • 400 AdalGenericError – Det gick inte att slutföra åtgärden eftersom ett Azure Active Directory-fel påträffades.

  • 400 GeoReplicationDatabaseNotSecondary – Åtgärden förväntar sig att databasen är ett replikeringsmål.

  • 400 AdalServicePrincipalNotFound – Det gick inte att slutföra åtgärden eftersom det inte gick att hitta tjänstens huvudnamn för Azure Active Directory-biblioteket.

  • 400 AzureKeyVaultMalformedVaultUri – den angivna Key Vault URI är inte giltig.

  • 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.

  • 404 ResourceNotFound – Den begärda resursen hittades inte.

  • 404 SourceDatabaseNotFound – källdatabasen finns inte.

  • 404 ServerNotInSubscription – Den angivna servern finns inte i den angivna prenumerationen.

  • 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

  • 405 UnsupportedReplicationOperation – En replikeringsåtgärd som inte stöds initierades på databasen.

  • 409 ManagedInstanceHasHybridLink – Användaren försökte initiera en åtgärd som inte stöds när en hanterad instans har en hybridlänk konfigurerad.

  • 409 RemoteDatabaseExists – Måldatabasnamnet finns redan på målservern.

  • 409 ConflictingServerOperation – En åtgärd pågår för servern.

  • 409 SubscriptionDisabled – Prenumerationen är inaktiverad.

  • 409 InstanceFailoverGroupAlreadyExists – Redundansgruppen finns redan på en viss server.

  • 409 InstanceFailoverGroupBusy – Redundansgruppen för instanser är upptagen med en annan åtgärd.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo – Användaren försökte redundansväxlara eller tvinga fram en geo-länk medan den sekundära är i ett tillstånd där den kanske inte är fysiskt konsekvent och därför inte kan ange den primära rollen.

  • 409 InstanceFailoverGroupDnsRecordInUse – Det finns en duplicerad DNS-post för den begärda slutpunkten.

  • 409 ServerKeyNameAlreadyExists – servernyckeln finns redan på servern.

  • 409 ServerKeyUriAlreadyExists – servernyckelns URI finns redan på servern.

  • 409 ServerKeyDoesNotExists – servernyckeln finns inte.

  • 409 InvalidFailoverGroupName – Ogiltigt namn på redundansgrupp för instans angavs.

  • 409 UpdateSloInProgress – Användaren försökte initiera en inkompatibel åtgärd medan en SLO-uppdatering pågick.

  • 409 AzureKeyVaultKeyNameNotFound – Åtgärden kunde inte slutföras eftersom Azure Key Vault Nyckelnamn inte finns.

  • 409 AzureKeyVaultKeyInUse – Nyckeln används för närvarande av servern.

  • 409 ConflictingSystemOperationInProgress – En systemunderhållsåtgärd pågår i databasen och ytterligare åtgärder måste vänta tills den har slutförts.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship – En replikerings seeding-åtgärd utfördes på en databas som redan finns i en replikeringsrelation.

  • 409 InvalidDatabaseStateForOperation – Åtgärden tillåts inte i databasen i dess aktuella replikeringstillstånd.

  • 409 DuplicateGeoDrRelation – databaserna är redan i en replikeringsrelation. Det här är en duplicerad begäran.

  • 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 429 SubscriptionTooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

  • 503 AzureKeyVaultConnectionFailed – Det gick inte att slutföra åtgärden på servern eftersom försök att ansluta till Azure Key Vault misslyckades

  • 503 AzureKeyVaultGenericConnectionError – Det gick inte att slutföra åtgärden eftersom ett fel påträffades när Key Vault information skulle hämtas.

  • 504 RequestTimeout – Tjänstbegäran överskred den tillåtna tidsgränsen.

Exempel

Get failover group

Sample Request

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=2021-11-01

Sample Response

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

Definitioner

Name Description
InstanceFailoverGroup

En redundansgrupp för instanser.

InstanceFailoverGroupReadOnlyEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

InstanceFailoverGroupReadWriteEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

InstanceFailoverGroupReplicationRole

Lokal replikeringsroll för redundansgruppinstansen.

ManagedInstancePairInfo

Par med hanterade instanser i redundansgruppen.

PartnerRegionInfo

Partnerregionsinformation för redundansgruppen.

ReadOnlyEndpointFailoverPolicy

Redundansprincip för den skrivskyddade slutpunkten för redundansgruppen.

ReadWriteEndpointFailoverPolicy

Redundansprincip för läs- och skrivslutpunkten för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

InstanceFailoverGroup

En redundansgrupp för instanser.

Name Typ Description
id

string

Resurs-ID.

name

string

Resursnamn.

properties.managedInstancePairs

ManagedInstancePairInfo[]

Lista över hanterade instanspar i redundansgruppen.

properties.partnerRegions

PartnerRegionInfo[]

Partnerregionsinformation för redundansgruppen.

properties.readOnlyEndpoint

InstanceFailoverGroupReadOnlyEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

properties.readWriteEndpoint

InstanceFailoverGroupReadWriteEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

properties.replicationRole

InstanceFailoverGroupReplicationRole

Lokal replikeringsroll för redundansgruppinstansen.

properties.replicationState

string

Replikeringstillstånd för redundansklusterinstansen.

type

string

Resurstyp.

InstanceFailoverGroupReadOnlyEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

Name Typ Description
failoverPolicy

ReadOnlyEndpointFailoverPolicy

Redundansprincip för den skrivskyddade slutpunkten för redundansgruppen.

InstanceFailoverGroupReadWriteEndpoint

Skrivskyddad slutpunkt för redundansklusterinstansen.

Name Typ Description
failoverPolicy

ReadWriteEndpointFailoverPolicy

Redundansprincip för läs- och skrivslutpunkten för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

failoverWithDataLossGracePeriodMinutes

integer

Respitperiod före redundansväxling med dataförlust görs för läs-/skriv-slutpunkten. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Lokal replikeringsroll för redundansgruppinstansen.

Name Typ Description
Primary

string

Secondary

string

ManagedInstancePairInfo

Par med hanterade instanser i redundansgruppen.

Name Typ Description
partnerManagedInstanceId

string

ID för partnerhanterad instans i par.

primaryManagedInstanceId

string

ID för primär hanterad instans i par.

PartnerRegionInfo

Partnerregionsinformation för redundansgruppen.

Name Typ Description
location

string

Geoplats för partnerhanterade instanser.

replicationRole

InstanceFailoverGroupReplicationRole

Replikeringsrollen för partnerhanterade instanser.

ReadOnlyEndpointFailoverPolicy

Redundansprincip för den skrivskyddade slutpunkten för redundansgruppen.

Name Typ Description
Disabled

string

Enabled

string

ReadWriteEndpointFailoverPolicy

Redundansprincip för läs- och skrivslutpunkten för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

Name Typ Description
Automatic

string

Manual

string