Failover Groups - Force Failover Allow Data Loss

Tjänst:: SQL Database

API-version:: 2025-01-01

Redundansväxlar från den aktuella primära servern till den här servern. Den här åtgärden kan leda till dataförlust.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
failoverGroupName	path	True	string	Namnet på redundansgruppen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	FailoverGroup	Azure-operationen slutfördes framgångsrikt.
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

FailoverGroup

Azure-operationen slutfördes framgångsrikt.

202 Accepted

Resursåtgärden har godkänts.

Sidhuvuden

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Forced failover of a failover group allowing data loss

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server/failoverGroups/failover-group-test-3/forceFailoverAllowDataLoss?api-version=2025-01-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/SQL/stable/2025-01-01/examples/FailoverGroupForceFailoverAllowDataLoss.json
// this example is just showing the usage of "FailoverGroups_ForceFailoverAllowDataLoss" 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://learn.microsoft.com/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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-secondary-server";
string failoverGroupName = "failover-group-test-3";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
ArmOperation<FailoverGroupResource> lro = await failoverGroup.ForceFailoverAllowDataLossAsync(WaitUntil.Completed);
FailoverGroupResource 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
FailoverGroupData 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

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

Statuskod:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japanwest/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
FailoverGroup	En redundansgrupp.
FailoverGroupDatabasesSecondaryType	Databasers sekundära typ på partnerservern.
FailoverGroupReadOnlyEndpoint	Skrivskyddad slutpunkt för redundansklusterinstansen.
FailoverGroupReadWriteEndpoint	Skrivskyddad slutpunkt för redundansklusterinstansen.
FailoverGroupReplicationRole	Den lokala replikeringsrollen för redundansklusterinstansen.
PartnerInfo	Partnerserverinformation för redundansgruppen.
ReadOnlyEndpointFailoverPolicy	Redundansprincip för den skrivskyddade slutpunkten för redundansgruppen.
ReadWriteEndpointFailoverPolicy	Redundansprincip för skrivskyddad slutpunkt för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

FailoverGroup

Objekt

En redundansgrupp.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Resursplats.
name	string	Namnet på resursen
properties.databases	string[] (arm-id)	Lista över databaser i redundansgruppen.
properties.partnerServers	PartnerInfo[]	Lista över partnerserverinformation för redundansgruppen.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Skrivskyddad slutpunkt för redundansklusterinstansen.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Skrivskyddad slutpunkt för redundansklusterinstansen.
properties.replicationRole	FailoverGroupReplicationRole	Den lokala replikeringsrollen för redundansklusterinstansen.
properties.replicationState	string	Replikeringstillstånd för redundansklusterinstansen.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Databasers sekundära typ på partnerservern.
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
tags	object	Resursetiketter.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

FailoverGroupDatabasesSecondaryType

Uppräkning

Databasers sekundära typ på partnerservern.

Värde	Description
Geo	Geo
Standby	Vänteläge

FailoverGroupReadOnlyEndpoint

Objekt

Skrivskyddad slutpunkt för redundansklusterinstansen.

Name	Typ	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Redundansprincip för den skrivskyddade slutpunkten för redundansgruppen.
targetServer	string (arm-id)	Målpartnerservern där den skrivskyddade slutpunkten pekar på.

FailoverGroupReadWriteEndpoint

Objekt

Skrivskyddad slutpunkt för redundansklusterinstansen.

Name	Typ	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Redundansprincip för skrivskyddad slutpunkt för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Respitperiod före redundansväxling med dataförlust görs för läs- och skrivslutpunkten. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

FailoverGroupReplicationRole

Uppräkning

Den lokala replikeringsrollen för redundansklusterinstansen.

Värde	Description
Primary	Primär
Secondary	Secondary

PartnerInfo

Objekt

Partnerserverinformation för redundansgruppen.

Name	Typ	Description
id	string (arm-id)	Resursidentifierare för partnerservern.
location	string	Geoplats för partnerservern.
replicationRole	FailoverGroupReplicationRole	Replikeringsrollen för partnerservern.

ReadOnlyEndpointFailoverPolicy

Uppräkning

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

Värde	Description
Disabled	Inaktiverad
Enabled	Aktiverad

ReadWriteEndpointFailoverPolicy

Uppräkning

Redundansprincip för skrivskyddad slutpunkt för redundansgruppen. Om failoverPolicy är Automatisk krävs failoverWithDataLossGracePeriodMinutes.

Värde	Description
Manual	Manuell
Automatic	Automatiskt

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.