Replication Links - List By Database

Lists a database's replication links.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks?api-version={api-version}
Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

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.

databaseName
path True
  • string

The name of the database to retrieve links for.

api-version
query True
  • string

The API version to use for the request.

Name Type Description
200 OK

OK

Examples

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/databases/testdb/replicationLinks?api-version=2014-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/databases/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238",
      "name": "5b301b68-03f6-4b26-b0f4-73ebb8634238",
      "type": "Microsoft.Sql/servers/databases/replicationLinks",
      "location": "Japan East",
      "properties": {
        "partnerServer": "sqlcrudtest-5961",
        "partnerDatabase": "testdb",
        "partnerLocation": "Japan East",
        "role": "Secondary",
        "partnerRole": "Primary",
        "replicationMode": "ASYNC",
        "startTime": "2017-02-10T01:44:27.117Z",
        "percentComplete": 100,
        "replicationState": "CATCH_UP",
        "isTerminationAllowed": true
      }
    }
  ]
}

Definitions

ReplicationLink

Represents a database replication link.

ReplicationLinkListResult

Represents a database replication link.

Name Type Description
isTerminationAllowed
  • boolean

Legacy value indicating whether termination is allowed. Currently always returns true.

location
  • string

Location of the server that contains this firewall rule.

partnerDatabase
  • string

The name of the partner database.

partnerLocation
  • string

The Azure Region of the partner database.

partnerRole
  • enum:
    • Primary
    • Secondary
    • NonReadableSecondary
    • Source
    • Copy

The role of the partner database in the replication link.

partnerServer
  • string

The name of the server hosting the partner database.

percentComplete
  • integer
    int32

The percentage of seeding complete for the replication link.

replicationMode
  • string

Replication mode of this replication link.

replicationState
  • enum:
    • PENDING
    • SEEDING
    • CATCH_UP
    • SUSPENDED

The replication state for the replication link.

role
  • enum:
    • Primary
    • Secondary
    • NonReadableSecondary
    • Source
    • Copy

The role of the database in the replication link.

startTime
  • string
    date-time

The start time for the replication link.

type
  • string

Type of resource this is.

Name Type Description
value

The list of database replication links housed in the database.