Share via

Get Database Copy (classic)


THIS TOPIC APPLIES TO: noSQL Server yesAzure SQL DatabaseyesAzure SQL Data Warehouse noParallel Data Warehouse

Gets details for an Azure SQL Database copy.


The recommended REST commands to work with SQL Database are the Resource Manager based Azure SQL Database REST API. While there is no change to SQL Database, be aware that the classic deployment model command in this article is scheduled for deprecation on December 1, 2019. For a table providing links to the specific new commands you should use, see Operations for Azure SQL Databases.


The Get Database Copy request must be specified as follows:

Method Request URI HTTP Version
GET{subscriptionId}/services/sqlservers/servers/{serverName}/databases/{databaseName}/databasecopies/{linkID} HTTP/1.1

URI Parameters


Request Headers

The following table describes the required and optional request headers:

Request Header Description
x-ms-version Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01.

Request Body



The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A value that uniquely identifies a request made against the database management service. This request id is used for request tracking. If a failure occurs that requires the user to contact Microsoft Support, the request id should be provided to Microsoft to assist in tracking and resolving the failure for the request.

Response Body

The following is an example response body:

<ServiceResource xmlns="" xmlns:i="">  
  <IsOfflineSecondary>True</IsOfflineSecondary >  

The following table describes the elements in the response body:

Name The link ID for the database copy. This is the same as the link ID in sys.dm_database_copies. It is a GUID which is used in the resource paths for the Get Database Copy, Update Database Copy, and Stop Database Copy requests.
Type The server-side type of the database copy.
State Describes the state of the resource. The value is always Normal for database copies.
SelfLink The URI to the database copy.
ParentLink Link to the parent resource.
SourceServerName The server that is the source for the copy.
SourceDatabaseName The database that is the source for the copy.
DestinationServerName The server that is the destination for the copy.
DestinationDatabaseName The database that is the destination for the copy.
IsContinuous Specifies that the copy is a continuous copy.
IsOfflineSecondary When True, specifies that the copy should be a passive continuous copy.
IsTerminationAllowed When True, specifies that the passive continuous copy has permission to failover.
StartDate The time the copy was started.
ModifyDate The time the copy was last modified.
PercentComplete Percent complete of the copy. For continuous copies, this only applies to the SEEDING (initial copy) phase.
ReplicationState An integer representing the replication state of the database. Possible values are:

- 0: PENDING (the copy hasn't started yet)
- 1: SEEDING (the initial copy is in progress)
- 2: CATCH_UP (for continuous copies, indicates that the initial copy is complete and asynchronous commits are being propagated to the target)

Other values (like 3) are possible. The corresponding ReplicationStateDescription would be NULL).

The meaning of these values will not change in future releases.
ReplicationStateDescription The string description for the ReplicationState (see ReplicationState).
LocalDatabaseId The ID of the local database (the same as the id in sys.databases). If the resource path for the request is to the source database, this will be the ID of the source databases. If the resource path for the request is to the target database, this will be the ID of the target database.
IsLocalDatabaseReplicationTarget Whether or not the local database (see LocalDatabaseId) is the target for the copy.
IsInterlinkConnected If the database copy is interlink connected.

See Also

Common REST API Error Codes
Azure SQL Database
Operations for Azure SQL Databases
Copying Databases in Azure SQL Database
Geo-Replication in Azure SQL Database