通过

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

Sync Agents - Get

  • 参考
服务:
SQL Database
API 版本:
2023-08-01

获取同步代理。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}?api-version=2023-08-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

SyncAgent

已成功检索指定的同步代理。
Other Status Codes

ErrorResponse

错误响应： ***

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

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

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

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

  • 400 InvalidSyncGroupName - 同步组名称无效。 此字段可以包含字母、数字、短划线和下划线。

  • 400 InvalidSyncMemberName - 同步成员名称无效。 此字段可以包含字母、数字、短划线和下划线。

  • 400 MissingSyncMemberName - 缺少同步成员名称

  • 400 InvalidSyncGroupInterval - 同步间隔应大于或等于 5 秒。

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

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

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

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

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

  • 400 MissingServerName - 缺少服务器名称

  • 400 MissingDatabaseName - 缺少数据库名称

  • 400 MissingSyncGroupName - 缺少同步组名称

  • 400 MissingConflictResolutionPolicy - 缺少冲突解决策略

  • 400 MissingSyncAgentName - 缺少同步代理名称

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

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

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

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

  • 400 CannotDeleteInUseSyncAgent - 无法删除同步代理，因为它由同步成员使用。

  • 400 InvalidSyncAgent - 同步代理无效。

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

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

  • 404 SubscriptionNotFound - 找不到请求的订阅。

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

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

  • 409 SyncOperation_AgentAlreadyExists - 已存在同名的同步代理。

  • 409 SyncOperation_AgentIdAlreadyExists - 已存在具有相同 ID 的同步代理。

  • 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。

  • 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

Get a sync agent

示例请求

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

示例响应

状态代码:
200 
{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
SyncAgent

Azure SQL 数据库同步代理。
SyncAgentState

同步代理的状态。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

SyncAgent

Object

Azure SQL 数据库同步代理。

名称 类型 说明
id

string

资源 ID。
name

string

资源名称。
properties.expiryTime

string (date-time)

同步代理版本的过期时间。
properties.isUpToDate

boolean

如果同步代理版本是最新的。
properties.lastAliveTime

string (date-time)

同步代理的最后一个活动时间。
properties.name

string

同步代理的名称。
properties.state

SyncAgentState

同步代理的状态。
properties.syncDatabaseId

string

同步代理中同步数据库的 ARM 资源 ID。
properties.version

string

同步代理的版本。
type

string

资源类型。

SyncAgentState

枚举

同步代理的状态。

值 说明
NeverConnected
Offline
Online