Databases - Force Link To Replication Group

Service:

Redis Cache

API Version:

2024-10-01

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceLinkToReplicationGroup?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens Regex pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
databaseName	path	True	string	The name of the Redis Enterprise database. Regex pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
geoReplication	True	GeoReplication	Properties to configure geo replication for this database.

Responses

Name	Type	Description
202 Accepted		Force link operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome. Headers Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

How to relink a database after a regional outage

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/forceLinkToReplicationGroup?api-version=2024-10-01

{
  "geoReplication": {
    "groupNickname": "groupName",
    "linkedDatabases": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
      },
      {
        "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
      }
    ]
  }
}

Sample response

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Cache/...pathToOperationStatus...

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ForceLinkParameters	Parameters for reconfiguring active geo-replication, of an existing database that was previously unlinked from a replication group.
GeoReplication	Optional set of properties to configure geo replication for this database.
LinkedDatabase	Linked Database
LinkState	State of the link between the database resources.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ForceLinkParameters

Parameters for reconfiguring active geo-replication, of an existing database that was previously unlinked from a replication group.

Name	Type	Description
geoReplication	GeoReplication	Properties to configure geo replication for this database.

GeoReplication

Optional set of properties to configure geo replication for this database.

Name	Type	Description
groupNickname	string	Name for the group of linked database resources
linkedDatabases	LinkedDatabase[]	List of database resources to link with this database

LinkedDatabase

Linked Database

Name	Type	Description
id	string	Resource ID of a database resource to link with this database.
state	LinkState	State of the link between the database resources.

LinkState

State of the link between the database resources.

Name	Type	Description
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string