Replication Links - Failover Allow Data Loss

Reference

Service:: SQL Database

API Version:: 2021-11-01

Fails over from the current primary server to this server allowing data loss.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
linkId	path	True	string	The name of the replication link.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	ReplicationLink	Successfully failed over.
202 Accepted		Failover operation is in progress.
Other Status Codes		* Error Responses: * 400 ReplicationLinksReplicationLinkNameIsInvalid - Replication link name should be a valid guid. 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target. 400 LedgerNoDropLink - Geo-replication cannot be stopped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation. 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed. 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target. 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation. 400 InvalidServerName - Invalid server name specified. 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link. 404 OperationIdNotFound - The operation with Id does not exist. 404 ResourceNotFound - The requested resource was not found. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 OperationIdNotFound - The operation with Id does not exist. 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship. 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role. 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request. 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress. 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later. 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed. 409 FailoverGroupAlreadySetup - The operation cannot be performed because the geo-replication link is part of a Failover Group. You must remove the database from the group in order to individually terminate or failover. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Name

Type

Description

200 OK

ReplicationLink

Successfully failed over.

202 Accepted

Failover operation is in progress.

Other Status Codes

*** Error Responses: ***

400 ReplicationLinksReplicationLinkNameIsInvalid - Replication link name should be a valid guid.
400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.
400 LedgerNoDropLink - Geo-replication cannot be stopped because the database has Ledger Digest Uploads enabled. Disable Ledger Digest Uploads and retry the operation.
400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.
400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.
400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.
400 InvalidServerName - Invalid server name specified.
400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.
400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.
400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.
404 OperationIdNotFound - The operation with Id does not exist.
404 ResourceNotFound - The requested resource was not found.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.
404 OperationIdNotFound - The operation with Id does not exist.
404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
409 OperationCancelled - The operation has been cancelled by user.
409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.
409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.
409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.
409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.
409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.
409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.
409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.
409 FailoverGroupAlreadySetup - The operation cannot be performed because the geo-replication link is part of a Failover Group. You must remove the database from the group in order to individually terminate or failover.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Forced 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/forceFailoverAllowDataLoss?api-version=2021-11-01


/**
 * Samples for ReplicationLinks FailoverAllowDataLoss.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ReplicationLinkFailoverAllowDataLoss.
     * json
     */
    /**
     * Sample code: Forced failover of a replication link.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void forcedFailoverOfAReplicationLink(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getReplicationLinks().failoverAllowDataLoss("Default", "sourcesvr",
            "gamma-db", "4891ca10-ebd0-47d7-9182-c722651780fb", com.azure.core.util.Context.NONE);
    }
}

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

Sample response

Status code:: 200

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "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"
}

Status code:: 202

Definitions

Name	Description
ReplicationLink	A replication link.
ReplicationLinkType	Link type (GEO, NAMED, STANDBY).
ReplicationRole	Local replication role.
ReplicationState	Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).

ReplicationLink

A replication link.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.isTerminationAllowed	boolean	Whether the user is currently allowed to terminate the link.
properties.linkType	ReplicationLinkType	Link type (GEO, NAMED, STANDBY).
properties.partnerDatabase	string	Resource partner database.
properties.partnerLocation	string	Resource partner location.
properties.partnerRole	ReplicationRole	Partner replication role.
properties.partnerServer	string	Resource partner server.
properties.percentComplete	integer	Seeding completion percentage for the link.
properties.replicationMode	string	Replication mode.
properties.replicationState	ReplicationState	Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Local replication role.
properties.startTime	string	Time at which the link was created.
type	string	Resource type.

ReplicationLinkType

Link type (GEO, NAMED, STANDBY).

Name	Type	Description
GEO	string
NAMED	string
STANDBY	string

ReplicationRole

Local replication role.

Name	Type	Description
Copy	string
NonReadableSecondary	string
Primary	string
Secondary	string
Source	string

ReplicationState

Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).

Name	Type	Description
CATCH_UP	string
PENDING	string
SEEDING	string
SUSPENDED	string

Share via

Replication Links - Failover Allow Data Loss

URI Parameters

Responses

Examples

Forced failover of a replication link

Sample request

Sample response

Definitions

ReplicationLink

ReplicationLinkType

ReplicationRole

ReplicationState

Additional resources