Replication Links - Failover

Tjänst:: SQL Database

API-version:: 2023-08-01

Redundansväxlar från den aktuella primära servern till den här servern.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover?api-version=2023-08-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen.
linkId	path	True	string	Namnet på replikeringslänken.
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.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID 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	ReplicationLink	Har växlat över.
202 Accepted		Redundansåtgärd pågår. Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Felsvar: *** 400 ReplicationLinksReplicationLinkNameIsInvalid – Replikeringslänknamnet ska vara ett giltigt guid. 400 GeoReplicationDatabaseNotSecondary – Åtgärden förväntar sig att databasen är ett replikeringsmål. 400 ReplicationLinksReplicationLinkTypeIsInvalid – LinkType är ogiltig. Giltiga värden är STANDBY och GEO. 400 ReplicationLinksCreateIsNotSupported – Det går inte att skapa replikeringslänken. 400 LedgerNoDropLink – Geo-replikering kan inte stoppas eftersom transaktionsregisteruppladdningar är aktiverade i databasen. Inaktivera uppladdningar av transaktionsregistersammandrag och försök utföra åtgärden igen. 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 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd 400 InvalidServerName – Ogiltigt servernamn har angetts. 400 GeoReplicationDatabaseNotSecondary – Åtgärden förväntar sig att databasen är ett replikeringsmål. 400 CannotUseTrailingWhitespacesInDatabaseName – Verifieringen av databasnamn misslyckades. 400 IncorrectReplicationLinkState – Åtgärden förväntar sig att databasen är i ett förväntat tillstånd på replikeringslänken. 400 PlannedFailoverTimedOut – Användaren anropade planerad redundans och tidsgränsen uppnåddes när partnerhanteringstjänsten skulle kontaktas. 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave – Konfiguration av geo-replikering stöds inte för databaser med olika värden för egenskapen preferredEnclaveType. Den primära databasen{0}på servern{1}använder{2}preferredEnclaveType, medan den angivna preferredEnclaveType för den sekundära databasen{3}på servern{4}är{5}. 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes – Planerad redundans mellan primär och sekundär databas med olika preferredEnclaveType stöds inte för virtualiseringsbaserade säkerhets enklaver (VBS). 400 CannotUseReservedDatabaseName – Det går inte att använda reserverat databasnamn i den här åtgärden. 400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken. 404 OperationIdNotFound – Åtgärden med ID finns inte. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 OperationIdNotFound – Åtgärden med ID finns inte. 404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen. 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 409 UpdateSloInProgress – Användaren försökte initiera en inkompatibel åtgärd medan en SLO-uppdatering pågick. 409 InvalidOperationForDatabaseNotInReplicationRelationship – En replikeringsåtgärd utfördes på en databas som inte finns i en replikeringsrelation. 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 DuplicateGeoDrRelation – databaserna är redan i en replikeringsrelation. Det här är en duplicerad begäran. 409 GeoReplicationCannotBecomePrimaryDuringUndo – Användaren försökte redundanshantera 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 ManagementServiceDatabaseBusy – databasens{0}är upptagen med en annan åtgärd. Försök med åtgärden senare. 409 FailoverGroupAlreadySetup – Åtgärden kan inte utföras eftersom geo-replikeringslänken ingår i en redundansgrupp. Du måste ta bort databasen från gruppen för att kunna avsluta eller redundans. 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Name

Typ

Description

200 OK

ReplicationLink

Har växlat över.

202 Accepted

Redundansåtgärd pågår.

Sidhuvuden

Location: string

Other Status Codes

ErrorResponse

Felsvar: ***

400 ReplicationLinksReplicationLinkNameIsInvalid – Replikeringslänknamnet ska vara ett giltigt guid.
400 GeoReplicationDatabaseNotSecondary – Åtgärden förväntar sig att databasen är ett replikeringsmål.
400 ReplicationLinksReplicationLinkTypeIsInvalid – LinkType är ogiltig. Giltiga värden är STANDBY och GEO.
400 ReplicationLinksCreateIsNotSupported – Det går inte att skapa replikeringslänken.
400 LedgerNoDropLink – Geo-replikering kan inte stoppas eftersom transaktionsregisteruppladdningar är aktiverade i databasen. Inaktivera uppladdningar av transaktionsregistersammandrag och försök utföra åtgärden igen.
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 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd
400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd
400 InvalidServerName – Ogiltigt servernamn har angetts.
400 GeoReplicationDatabaseNotSecondary – Åtgärden förväntar sig att databasen är ett replikeringsmål.
400 CannotUseTrailingWhitespacesInDatabaseName – Verifieringen av databasnamn misslyckades.
400 IncorrectReplicationLinkState – Åtgärden förväntar sig att databasen är i ett förväntat tillstånd på replikeringslänken.
400 PlannedFailoverTimedOut – Användaren anropade planerad redundans och tidsgränsen uppnåddes när partnerhanteringstjänsten skulle kontaktas.
400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave – Konfiguration av geo-replikering stöds inte för databaser med olika värden för egenskapen preferredEnclaveType. Den primära databasen{0}på servern{1}använder{2}preferredEnclaveType, medan den angivna preferredEnclaveType för den sekundära databasen{3}på servern{4}är{5}.
400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes – Planerad redundans mellan primär och sekundär databas med olika preferredEnclaveType stöds inte för virtualiseringsbaserade säkerhets enklaver (VBS).
400 CannotUseReservedDatabaseName – Det går inte att använda reserverat databasnamn i den här åtgärden.
400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken.
404 OperationIdNotFound – Åtgärden med ID finns inte.
404 ResourceNotFound – Den begärda resursen hittades inte.
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 OperationIdNotFound – Åtgärden med ID finns inte.
404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen.
409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.
409 OperationCancelled – Åtgärden har avbrutits av användaren.
409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.
409 UpdateSloInProgress – Användaren försökte initiera en inkompatibel åtgärd medan en SLO-uppdatering pågick.
409 InvalidOperationForDatabaseNotInReplicationRelationship – En replikeringsåtgärd utfördes på en databas som inte finns i en replikeringsrelation.
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 DuplicateGeoDrRelation – databaserna är redan i en replikeringsrelation. Det här är en duplicerad begäran.
409 GeoReplicationCannotBecomePrimaryDuringUndo – Användaren försökte redundanshantera 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 ManagementServiceDatabaseBusy – databasens{0}är upptagen med en annan åtgärd. Försök med åtgärden senare.
409 FailoverGroupAlreadySetup – Åtgärden kan inte utföras eftersom geo-replikeringslänken ingår i en redundansgrupp. Du måste ta bort databasen från gruppen för att kunna avsluta eller redundans.
429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.
500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Planned failover of a replication link

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb/failover?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ReplicationLinkFailover.json
// this example is just showing the usage of "ReplicationLinks_Failover" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "4891ca10-ebd0-47d7-9182-c722651780fb";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.FailoverAsync(WaitUntil.Completed);
SqlServerDatabaseReplicationLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDatabaseReplicationLinkData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exempelsvar

Statuskod:: 200

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "role": "Primary",
    "partnerRole": "Secondary",
    "replicationMode": "ASYNC",
    "startTime": "2018-06-21T08:12:43.783Z",
    "percentComplete": 100,
    "replicationState": "CATCH_UP",
    "isTerminationAllowed": true,
    "linkType": "GEO"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "name": "4891ca10-ebd0-47d7-9182-c722651780fb"
}

Statuskod:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/replicationLinksOperationResults/replicationlink-group-test-3?api-version=2022-05-01-preview

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ReplicationLink	En replikeringslänk.
ReplicationLinkType	Länktyp (GEO, NAMED, STANDBY). Uppdateringsåtgärden stöder inte NAMED.
ReplicationRole	Lokal replikeringsroll.
ReplicationState	Replikeringstillstånd (VÄNTAR, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ReplicationLink

Objekt

En replikeringslänk.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.isTerminationAllowed	boolean	Om användaren för närvarande får avsluta länken.
properties.linkType	ReplicationLinkType	Länktyp (GEO, NAMED, STANDBY). Uppdateringsåtgärden stöder inte NAMED.
properties.partnerDatabase	string	Resurspartnerdatabas.
properties.partnerDatabaseId	string	Resurspartnerdatabas-ID.
properties.partnerLocation	string	Plats för resurspartner.
properties.partnerRole	ReplicationRole	Partnerreplikeringsroll.
properties.partnerServer	string	Resurspartnerserver.
properties.percentComplete	integer (int32)	Slutförandeprocent för seeding för länken.
properties.replicationMode	string	Replikeringsläge.
properties.replicationState	ReplicationState	Replikeringstillstånd (VÄNTAR, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Lokal replikeringsroll.
properties.startTime	string (date-time)	Tidpunkt då länken skapades.
type	string	Resurstyp.

ReplicationLinkType

Uppräkning

Länktyp (GEO, NAMED, STANDBY). Uppdateringsåtgärden stöder inte NAMED.

Värde	Description
GEO
NAMED
STANDBY

ReplicationRole

Uppräkning

Lokal replikeringsroll.

Värde	Description
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

Uppräkning

Replikeringstillstånd (VÄNTAR, SEEDING, CATCHUP, SUSPENDED).

Värde	Description
PENDING
SEEDING
CATCH_UP
SUSPENDED

Dela via

Replication Links - Failover

URI-parametrar

Svar

Exempel

Planned failover of a replication link

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkType

ReplicationRole

ReplicationState