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

Sync Members - List By Sync Group

列出给定同步组中的同步成员。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers?api-version=2021-11-01-preview

URI 参数

Name In Required Type Description
databaseName
path True
  • string

托管同步组的数据库的名称。

resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True
  • string

服务器的名称。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

syncGroupName
path True
  • string

同步组的名称。

api-version
query True
  • string

要用于请求的 API 版本。

响应

Name Type Description
200 OK

已成功检索同步成员的列表。

Other Status Codes

错误响应: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - 创建或更新同步组请求正文为空。

  • 400 InvalidSyncMemberCreateOrUpdateRequest - 创建或更新同步成员请求正文为空。

  • 400 InvalidSyncAgentCreateOrUpdateRequest - 创建或更新同步代理请求正文为空。

  • 400 InvalidDatabaseResourceId - 数据库资源标识符无效。

  • 400 不匹配SubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。

  • 400 InvalidSyncAgentResourceId - 同步代理资源标识符无效。

  • 400 不匹配ResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。

  • 400 不匹配ServerNameWithUrl - 提供的服务器名称与 URL 中的名称不匹配。

  • 400 InvalidParameterValue - 向参数提供无效值。

  • 400 SyncOperation_GenericFailure - 无法执行数据同步操作。

  • 400 InvalidSyncGroup - 同步组无效。

  • 400 InvalidSyncMember - 同步成员无效。

  • 400 InvalidSyncAgent - 同步代理无效。

  • 400 CannotCreateSyncMemberDueToQuotaExceeded - 由于配额超出,无法创建同步成员。

  • 400 SyncOperation_DuplicateSyncMemberDrop - 同步成员已被删除。

  • 400 SyncOperation_WrongSyncDatabase - 指定的同步数据库与现有数据库不匹配。

  • 400 SyncOperation_DwInSyncGroup - 无法在数据同步中使用数据仓库版本。

  • 400 SyncOperation_MasterDbInSyncGroup - 无法在数据同步中使用逻辑主数据库。

  • 400 SyncOperation_InvalidCredential - 数据库凭据无效。

  • 400 InvalidSyncMetadataDatabase - 同步元数据数据库无效。

  • 404 ResourceNotFound - 找不到请求的资源。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 DatabaseDoesNotExist - 用户已指定在此服务器实例上不存在的数据库名称。

  • 404 SyncOperation_HubServerNotFound - 中心逻辑服务器不存在。

  • 404 SyncOperation_InvalidHubDatabase - 中心数据库无效。

  • 409 SyncOperation_DuplicateSyncMemberName - 无法创建同步成员,因为同步成员已存在同名。

示例

List sync members under a sync group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers?api-version=2021-11-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "databaseType": "AzureSqlDatabase",
        "serverName": "syncgroupcrud-3379.database.windows.net",
        "databaseName": "syncgroupcrud-7421",
        "userName": "myUser",
        "syncDirection": "Bidirectional",
        "syncState": "UnProvisioned",
        "usePrivateLinkConnection": true,
        "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
        "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
      "name": "syncmembercrud-4879",
      "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
    }
  ]
}

定义

SyncDirection

同步成员的同步方向。

SyncMember

Azure SQL 数据库同步成员。

SyncMemberDbType

同步成员的数据库类型。

SyncMemberListResult

Azure SQL 数据库同步成员的列表。

SyncMemberState

同步成员的同步状态。

SyncDirection

同步成员的同步方向。

Name Type Description
Bidirectional
  • string
OneWayHubToMember
  • string
OneWayMemberToHub
  • string

SyncMember

Azure SQL 数据库同步成员。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.databaseName
  • string

同步成员中成员数据库的数据库名称。

properties.databaseType

同步成员的数据库类型。

properties.password
  • string

同步成员成员中成员数据库的密码。

properties.privateEndpointName
  • string

如果启用了专用链接连接,则同步成员的专用终结点名称适用于 Azure 中的同步成员。

properties.serverName
  • string

同步成员成员中的成员数据库的服务器名称

properties.sqlServerDatabaseId
  • string

SQL Server同步成员的数据库 ID。

properties.syncAgentId
  • string

同步成员中同步代理的 ARM 资源 ID。

properties.syncDirection

同步成员的同步方向。

properties.syncMemberAzureDatabaseResourceId
  • string

同步成员逻辑数据库的 ARM 资源 ID,用于 Azure 中的同步成员。

properties.syncState

同步成员的同步状态。

properties.usePrivateLinkConnection
  • boolean

是否使用专用链接连接。

properties.userName
  • string

同步成员成员成员的用户名。

type
  • string

资源类型。

SyncMemberDbType

同步成员的数据库类型。

Name Type Description
AzureSqlDatabase
  • string
SqlServerDatabase
  • string

SyncMemberListResult

Azure SQL 数据库同步成员的列表。

Name Type Description
nextLink
  • string

用于检索下一页结果的链接。

value

结果数组。

SyncMemberState

同步成员的同步状态。

Name Type Description
DeProvisionFailed
  • string
DeProvisioned
  • string
DeProvisioning
  • string
DisabledBackupRestore
  • string
DisabledTombstoneCleanup
  • string
ProvisionFailed
  • string
Provisioned
  • string
Provisioning
  • string
ReprovisionFailed
  • string
Reprovisioning
  • string
SyncCancelled
  • string
SyncCancelling
  • string
SyncFailed
  • string
SyncInProgress
  • string
SyncSucceeded
  • string
SyncSucceededWithWarnings
  • string
UnProvisioned
  • string
UnReprovisioned
  • string