Instance Failover Groups - Force Failover Allow Data Loss

Service:: SQL Database

API-versie:: 2025-01-01

Failover van het huidige primaire beheerde exemplaar naar dit beheerde exemplaar. Deze bewerking kan leiden tot gegevensverlies.

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

URI-parameters

Name	In	Vereist	Type	Description
failoverGroupName	path	True	string	De naam van de failovergroep.
locationName	path	True	string	De naam van de regio waar de resource zich bevindt.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	InstanceFailoverGroup	Azure-operatie succesvol voltooid.
202 Accepted		Resourcebewerking geaccepteerd. Kopteksten Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Name

Type

Description

200 OK

InstanceFailoverGroup

Azure-operatie succesvol voltooid.

202 Accepted

Resourcebewerking geaccepteerd.

Kopteksten

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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/locations/Japan West/instanceFailoverGroups/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/InstanceFailoverGroupForceFailoverAllowDataLoss.json
// this example is just showing the usage of "InstanceFailoverGroups_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 InstanceFailoverGroupResource created on azure
// for more information of creating InstanceFailoverGroupResource, please refer to the document of InstanceFailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
AzureLocation locationName = new AzureLocation("Japan West");
string failoverGroupName = "failover-group-test-3";
ResourceIdentifier instanceFailoverGroupResourceId = InstanceFailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, locationName, failoverGroupName);
InstanceFailoverGroupResource instanceFailoverGroup = client.GetInstanceFailoverGroupResource(instanceFailoverGroupResourceId);

// invoke the operation
ArmOperation<InstanceFailoverGroupResource> lro = await instanceFailoverGroup.ForceFailoverAllowDataLossAsync(WaitUntil.Completed);
InstanceFailoverGroupResource 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
InstanceFailoverGroupData 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

Voorbeeldrespons

Statuscode:: 200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Statuscode:: 202

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
InstanceFailoverGroup	Een exemplaarfailovergroep.
InstanceFailoverGroupReadOnlyEndpoint	Alleen-lezeneindpunt van het exemplaar van de failovergroep.
InstanceFailoverGroupReadWriteEndpoint	Lees-schrijfeindpunt van het exemplaar van de failovergroep.
InstanceFailoverGroupReplicationRole	Lokale replicatierol van het exemplaar van de failovergroep.
ManagedInstancePairInfo	Paren van beheerde exemplaren in de failovergroep.
PartnerRegionInfo	Informatie over de partnerregio 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.
SecondaryInstanceType	Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

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

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

InstanceFailoverGroup

Object

Een exemplaarfailovergroep.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.managedInstancePairs	ManagedInstancePairInfo[]	Lijst met beheerde exemplaarparen in de failovergroep.
properties.partnerRegions	PartnerRegionInfo[]	Informatie over de partnerregio voor de failovergroep.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Alleen-lezeneindpunt van het exemplaar van de failovergroep.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Lees-schrijfeindpunt van het exemplaar van de failovergroep.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Lokale replicatierol van het exemplaar van de failovergroep.
properties.replicationState	string	Replicatiestatus van het exemplaar van de failovergroep.
properties.secondaryType	SecondaryInstanceType	Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt.
systemData	systemData	Azure Resource Manager metadata met creationBy en modifiedBy informatie.
type	string	Het type bron. Bijvoorbeeld: "Microsoft. Compute/virtualMachines" of "Microsoft. Opslag/opslagAccounts"

InstanceFailoverGroupReadOnlyEndpoint

Object

Alleen-lezeneindpunt van het exemplaar van de failovergroep.

Name	Type	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep.

InstanceFailoverGroupReadWriteEndpoint

Object

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.

InstanceFailoverGroupReplicationRole

Opsomming

Lokale replicatierol van het exemplaar van de failovergroep.

Waarde	Description
Primary	Primary
Secondary	Secundaire

ManagedInstancePairInfo

Object

Paren van beheerde exemplaren in de failovergroep.

Name	Type	Description
partnerManagedInstanceId	string	ID van Partner Managed Instance in pair.
primaryManagedInstanceId	string	ID van Primary Managed Instance in pair.

PartnerRegionInfo

Object

Informatie over de partnerregio voor de failovergroep.

Name	Type	Description
location	string	Geografische locatie van de beheerde exemplaren van de partner.
replicationRole	InstanceFailoverGroupReplicationRole	Replicatierol van de door de partner beheerde exemplaren.

ReadOnlyEndpointFailoverPolicy

Opsomming

Failoverbeleid van het alleen-lezen eindpunt voor de failovergroep.

Waarde	Description
Disabled	Disabled
Enabled	Ingeschakeld

ReadWriteEndpointFailoverPolicy

Opsomming

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

Waarde	Description
Manual	Handleiding
Automatic	Automatisch

SecondaryInstanceType

Opsomming

Type van het geo-secundaire exemplaar. Stel Stand-by in als het exemplaar alleen als dr-optie wordt gebruikt.

Waarde	Description
Geo	Geografie
Standby	Standby

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.