Sync Agents - List Linked Databases
Lists databases linked to a sync agent.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases?api-version=2021-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
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. |
server
|
path | True |
string |
The name of the server on which the sync agent is hosted. |
subscription
|
path | True |
string |
The subscription ID that identifies an Azure subscription. |
sync
|
path | True |
string |
The name of the sync agent. |
api-version
|
query | True |
string |
The API version to use for the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved sync agent linked SQL server databases. |
|
Other Status Codes |
*** Error Responses: ***
|
Examples
Get sync agent linked databases
Sample request
Sample response
{
"value": [
{
"properties": {
"databaseType": "SqlServerDatabase",
"databaseId": "55555555-6666-7777-8888-999999999999",
"description": "",
"serverName": "DummySqlServer",
"databaseName": "DummySqlServerDb",
"userName": "DummyUser"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases/55555555-6666-7777-8888-999999999999"
}
]
}
Definitions
Name | Description |
---|---|
Sync |
An Azure SQL Database sync agent linked database. |
Sync |
A list of sync agent linked databases. |
Sync |
Type of the sync agent linked database. |
SyncAgentLinkedDatabase
An Azure SQL Database sync agent linked database.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
name |
string |
Resource name. |
properties.databaseId |
string |
Id of the sync agent linked database. |
properties.databaseName |
string |
Database name of the sync agent linked database. |
properties.databaseType |
Type of the sync agent linked database. |
|
properties.description |
string |
Description of the sync agent linked database. |
properties.serverName |
string |
Server name of the sync agent linked database. |
properties.userName |
string |
User name of the sync agent linked database. |
type |
string |
Resource type. |
SyncAgentLinkedDatabaseListResult
A list of sync agent linked databases.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to retrieve next page of results. |
value |
Array of results. |
SyncMemberDbType
Type of the sync agent linked database.
Name | Type | Description |
---|---|---|
AzureSqlDatabase |
string |
|
SqlServerDatabase |
string |