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

Sync Groups - Update

更新同步组。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?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
properties.conflictLoggingRetentionInDays
  • integer

冲突日志记录保留期。

properties.conflictResolutionPolicy

同步组的冲突解决策略。

properties.enableConflictLogging
  • boolean

如果启用了冲突日志记录。

properties.hubDatabasePassword
  • string

同步组中心数据库凭据的密码。

properties.hubDatabaseUserName
  • string

同步组中心数据库凭据的用户名。

properties.interval
  • integer

同步组的同步间隔。

properties.schema

同步组的同步架构。

properties.syncDatabaseId
  • string

同步组中同步数据库的 ARM 资源 ID。

properties.usePrivateLinkConnection
  • boolean

如果启用了专用链接连接。

sku

SKU 的名称和容量。

响应

Name Type Description
200 OK

已成功更新同步组。

202 Accepted

正在更新同步组。

Other Status Codes

错误响应: ***

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

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

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

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

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

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

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

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

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

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

  • 400 InvalidSyncGroup - 同步组无效。

  • 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。

  • 400 CannotCreateSyncGroupDueToQuotaExceeded - 由于超出配额,无法创建同步组。

  • 400 SyncOperation_DuplicateSyncGroupDrop - 同步组已被删除。

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

  • 400 SyncOperation_UpdateSyncGroupWhenDropping - 无法更新同步组,因为它当前正在删除。

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

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

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

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

  • 400 SyncOperation_InvalidSyncInterval - 无法创建或更新同步组,因为同步间隔无效。

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

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

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

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

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

  • 409 SyncOperation_DuplicateSyncGroupName - 无法创建同步组,因为同步组已存在同名。

示例

Update a sync group

Sample Request

PATCH 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?api-version=2021-11-01-preview

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "hubDatabasePassword": "hubPassword",
    "usePrivateLinkConnection": true
  }
}

Sample Response

{
  "properties": {
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroup",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

定义

Sku

ARM 资源 SKU。

SyncConflictResolutionPolicy

同步组的冲突解决策略。

SyncGroup

Azure SQL 数据库同步组。

SyncGroupSchema

同步组架构的属性。

SyncGroupSchemaTable

同步组架构中表的属性。

SyncGroupSchemaTableColumn

同步组表中列的属性。

SyncGroupState

同步组的同步状态。

Sku

ARM 资源 SKU。

Name Type Description
capacity
  • integer

特定 SKU 的容量。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称,通常为字母 + 数字代码,例如 P3。

size
  • string

特定 SKU 的大小

tier
  • string

特定 SKU 的层或版本,例如基本 SKU 高级版。

SyncConflictResolutionPolicy

同步组的冲突解决策略。

Name Type Description
HubWin
  • string
MemberWin
  • string

SyncGroup

Azure SQL 数据库同步组。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.conflictLoggingRetentionInDays
  • integer

冲突日志记录保留期。

properties.conflictResolutionPolicy

同步组的冲突解决策略。

properties.enableConflictLogging
  • boolean

如果启用了冲突日志记录。

properties.hubDatabasePassword
  • string

同步组中心数据库凭据的密码。

properties.hubDatabaseUserName
  • string

同步组中心数据库凭据的用户名。

properties.interval
  • integer

同步组的同步间隔。

properties.lastSyncTime
  • string

同步组的上次同步时间。

properties.privateEndpointName
  • string

如果启用了专用链接连接,则同步组的专用终结点名称。

properties.schema

同步组的同步架构。

properties.syncDatabaseId
  • string

同步组中同步数据库的 ARM 资源 ID。

properties.syncState

同步组的同步状态。

properties.usePrivateLinkConnection
  • boolean

如果启用了专用链接连接。

sku

SKU 的名称和容量。

type
  • string

资源类型。

SyncGroupSchema

同步组架构的属性。

Name Type Description
masterSyncMemberName
  • string

架构所在的主同步成员的名称。

tables

同步组架构中的表列表。

SyncGroupSchemaTable

同步组架构中表的属性。

Name Type Description
columns

同步组架构中的列列表。

quotedName
  • string

同步组架构表的带引号名称。

SyncGroupSchemaTableColumn

同步组表中列的属性。

Name Type Description
dataSize
  • string

列的数据大小。

dataType
  • string

列的数据类型。

quotedName
  • string

同步组表列的带引号名称。

SyncGroupState

同步组的同步状态。

Name Type Description
Error
  • string
Good
  • string
NotReady
  • string
Progressing
  • string
Warning
  • string