你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sync Agents - List Linked Databases

Service:

SQL Database

API Version:

2021-11-01

Lists链接到同步代理的数据库。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases?api-version=2021-11-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	托管同步代理的服务器的名称。
subscriptionId	path	True	string	用于标识 Azure 订阅的订阅 ID。
syncAgentName	path	True	string	同步代理的名称。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	SyncAgentLinkedDatabaseListResult	已成功检索到同步代理链接的 SQL Server 数据库。
Other Status Codes		错误响应： *** 400 InvalidSyncGroupCreateOrUpdateRequest - 创建或更新同步组请求正文为空。 400 InvalidSyncMemberCreateOrUpdateRequest - 创建或更新同步成员请求正文为空。 400 InvalidSyncAgentCreateOrUpdateRequest - 创建或更新同步代理请求正文为空。 400 InvalidDatabaseResourceId - 数据库资源标识符无效。 400 MismatchingSubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。 400 InvalidSyncAgentResourceId - 同步代理资源标识符无效。 400 MismatchingResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。 400 MismatchingServerNameWithUrl - 提供的服务器名称与 URL 中的名称不匹配。 400 InvalidParameterValue - 为参数提供了无效值。 400 MissingServerName - 缺少服务器名称 400 MissingDatabaseName - 数据库名称缺失 400 MissingSyncGroupName - 缺少同步组名称 400 MissingConflictResolutionPolicy - 缺少冲突解决策略 400 MissingSyncAgentName - 缺少同步代理名称 400 SyncOperation_GenericFailure - 无法执行数据同步操作。 400 SyncOperation_WrongSyncDatabase - 指定的同步数据库与现有数据库不匹配。 400 SyncOperation_DwInSyncGroup - 无法在数据同步中使用 datawarehouse 版本。 400 SyncOperation_MasterDbInSyncGroup - 无法在数据同步中使用逻辑主数据库。 400 CannotDeleteInUseSyncAgent - 无法删除同步代理，因为它由同步成员使用。 400 InvalidSyncAgent - 同步代理无效。 400 InvalidSyncMetadataDatabase - 同步元数据数据库无效。 404 ResourceNotFound - 找不到请求的资源。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 DatabaseDoesNotExist - 用户指定了此服务器实例上不存在的数据库名称。 409 SyncOperation_AgentAlreadyExists - 已存在同名的同步代理。 409 SyncOperation_AgentIdAlreadyExists - 已存在具有相同 ID 的同步代理。

示例

Get sync agent linked databases

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for SyncAgents ListLinkedDatabases. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGetLinkedDatabases.json
     */
    /**
     * Sample code: Get sync agent linked databases.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSyncAgentLinkedDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().listLinkedDatabases("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187", 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

{
  "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"
    }
  ]
}

定义

名称	说明
SyncAgentLinkedDatabase	Azure SQL数据库同步代理链接数据库。
SyncAgentLinkedDatabaseListResult	同步代理链接数据库的列表。
SyncMemberDbType	同步代理链接数据库的类型。

SyncAgentLinkedDatabase

Azure SQL数据库同步代理链接数据库。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.databaseId	string	同步代理链接数据库的 ID。
properties.databaseName	string	同步代理链接数据库的数据库名称。
properties.databaseType	SyncMemberDbType	同步代理链接数据库的类型。
properties.description	string	同步代理链接数据库的说明。
properties.serverName	string	同步代理链接数据库的服务器名称。
properties.userName	string	同步代理链接数据库的用户名。
type	string	资源类型。

SyncAgentLinkedDatabaseListResult

同步代理链接数据库的列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	SyncAgentLinkedDatabase[]	结果数组。

SyncMemberDbType

同步代理链接数据库的类型。

名称	类型	说明
AzureSqlDatabase	string
SqlServerDatabase	string