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

Sync Groups - Create Or Update

服务:: SQL Database

API 版本:: 2025-01-01

创建或更新同步组。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
syncGroupName	path	True	string	同步组的名称。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
properties.conflictLoggingRetentionInDays	integer (int32)	冲突日志记录保持期。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同步组的冲突解决策略。
properties.enableConflictLogging	boolean	如果启用了冲突日志记录。
properties.hubDatabasePassword	string (password)	同步组中心数据库凭据的密码。
properties.hubDatabaseUserName	string	同步组中心数据库凭据的用户名。
properties.interval	integer (int32)	同步组的同步间隔。
properties.schema	SyncGroupSchema	同步组的同步架构。
properties.syncDatabaseId	string	同步组中同步数据库的 ARM 资源 ID。
properties.usePrivateLinkConnection	boolean	如果启用了专用链接连接。
sku	Sku	SKU 的名称和容量。

响应

名称	类型	说明
200 OK	SyncGroup	资源“SyncGroup”更新操作成功
201 Created	SyncGroup	资源“SyncGroup”创建操作成功标头 Location: string Retry-After: integer
202 Accepted		已接受资源作。标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create a sync group

Update a sync group

Create a sync group

示例请求

HTTP

PUT 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=2025-01-01

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

示例响应

状态代码:: 200

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

状态代码:: 201

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

状态代码:: 202

Update a sync group

示例请求

HTTP

PUT 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=2025-01-01

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

示例响应

状态代码:: 200

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

状态代码:: 201

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

状态代码:: 202

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Sku	ARM 资源 SKU。
SyncConflictResolutionPolicy	同步组的冲突解决策略。
SyncGroup	An Azure SQL 数据库 sync group.
SyncGroupSchema	同步组架构的属性。
SyncGroupSchemaTable	同步组架构中表的属性。
SyncGroupSchemaTableColumn	同步组表中列的属性。
SyncGroupState	同步组的同步状态。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Sku

对象

ARM 资源 SKU。

名称	类型	说明
capacity	integer (int32)	特定 SKU 的容量。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称，通常为字母 + 数字代码，例如 P3。
size	string	特定 SKU 的大小
tier	string	特定 SKU 的层或版本，例如基本 SKU、高级版。

SyncConflictResolutionPolicy

枚举

同步组的冲突解决策略。

值	说明
HubWin	HubWin
MemberWin	会员胜利

SyncGroup

对象

An Azure SQL 数据库 sync group.

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.conflictLoggingRetentionInDays	integer (int32)	冲突日志记录保持期。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同步组的冲突解决策略。
properties.enableConflictLogging	boolean	如果启用了冲突日志记录。
properties.hubDatabasePassword	string (password)	同步组中心数据库凭据的密码。
properties.hubDatabaseUserName	string	同步组中心数据库凭据的用户名。
properties.interval	integer (int32)	同步组的同步间隔。
properties.lastSyncTime	string (date-time)	同步组的上次同步时间。
properties.privateEndpointName	string	如果启用了专用链接连接，则同步组的专用终结点名称。
properties.schema	SyncGroupSchema	同步组的同步架构。
properties.syncDatabaseId	string	同步组中同步数据库的 ARM 资源 ID。
properties.syncState	SyncGroupState	同步组的同步状态。
properties.usePrivateLinkConnection	boolean	如果启用了专用链接连接。
sku	Sku	SKU 的名称和容量。
systemData	systemData	Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。
type	string	资源类型。例如，“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

SyncGroupSchema

对象

同步组架构的属性。

名称	类型	说明
masterSyncMemberName	string	架构所在的主同步成员的名称。
tables	SyncGroupSchemaTable[]	同步组架构中的表列表。

SyncGroupSchemaTable

对象

同步组架构中表的属性。

名称	类型	说明
columns	SyncGroupSchemaTableColumn[]	同步组架构中的列列表。
quotedName	string	同步组架构表的带引号名称。

SyncGroupSchemaTableColumn

对象

同步组表中列的属性。

名称	类型	说明
dataSize	string	列的数据大小。
dataType	string	列的数据类型。
quotedName	string	同步组表列的带引号名称。

SyncGroupState

枚举

同步组的同步状态。

值	说明
NotReady	NotReady
Error	Error
Warning	警告
Progressing	进展
Good	好

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Sync Groups - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Create a sync group

示例请求

示例响应

Update a sync group

示例请求

示例响应

定义

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

systemData