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

Sync Groups - Create Or Update

服务:: SQL Database

API 版本:: 2023-08-01

创建或更新同步组。

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

URI 参数

名称	在	必需	类型	说明
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 版本。

请求正文

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

响应

名称	类型	说明
200 OK	SyncGroup	已成功更新同步组。
201 Created	SyncGroup	已成功创建同步组。
202 Accepted		正在创建或更新同步组。标头 Location: string
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 InvalidSyncGroup - 同步组无效。 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。 400 CannotCreateSyncGroupDueToQuotaExceeded - 由于超出配额，无法创建同步组。 400 SyncOperation_DuplicateSyncGroupDrop - 同步组已被删除。 400 SyncOperation_WrongSyncDatabase - 指定的同步数据库与现有数据库不匹配。 400 SyncOperation_UpdateSyncGroupWhenDropping - 无法更新同步组，因为它当前正在删除。 400 SyncOperation_DwInSyncGroup - 无法在数据同步中使用数据仓库版本。 400 SyncOperation_MasterDbInSyncGroup - 无法在数据同步中使用逻辑主数据库。 400 SyncOperation_UnsupportedDataTypeColumnInSchema - 无法将列添加到架构，因为不支持该列的数据类型。 400 SyncOperation_InvalidCredential - 数据库凭据无效。 400 InvalidSyncMetadataDatabase - 同步元数据数据库无效。 400 SyncOperation_InvalidSyncInterval - 无法创建或更新同步组，因为同步间隔无效。 404 ResourceNotFound - 找不到请求的资源。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 DatabaseDoesNotExist - 用户已指定此服务器实例上不存在的数据库名称。 404 SyncOperation_HubServerNotFound - 中心逻辑服务器不存在。 404 SyncOperation_InvalidHubDatabase - 中心数据库无效。 404 OperationIdNotFound - ID作不存在。 409 SyncOperation_DuplicateSyncGroupName - 无法创建同步组，因为已存在同名的同步组。 409 CannotCancelOperation - 管理作处于无法取消的状态。 409 OperationCancelled -作已被用户取消。 409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 500 OperationTimedOut -作超时并自动回滚。请重试该作。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

Create a sync group

Update a sync group

Create a sync group

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=2023-08-01

{
  "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",
    "usePrivateLinkConnection": true
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncGroupCreate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

状态代码:: 201

{
  "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-8475"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

状态代码:: 202

Update a sync group

示例请求

HTTP
dotnet

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=2023-08-01

{
  "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",
    "usePrivateLinkConnection": true
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncGroupUpdate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

状态代码:: 201

{
  "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": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups"
}

状态代码:: 202

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Sku	ARM 资源 SKU。
SyncConflictResolutionPolicy	同步组的冲突解决策略。
SyncGroup	Azure SQL 数据库同步组。
SyncGroupSchema	同步组架构的属性。
SyncGroupSchemaTable	同步组架构中表的属性。
SyncGroupSchemaTableColumn	同步组表中列的属性。
SyncGroupState	同步组的同步状态。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

Sku

Object

ARM 资源 SKU。

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

SyncConflictResolutionPolicy

枚举

同步组的冲突解决策略。

值	说明
HubWin
MemberWin

SyncGroup

Object

Azure SQL 数据库同步组。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.conflictLoggingRetentionInDays	integer (int32)	冲突日志记录保持期。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同步组的冲突解决策略。
properties.enableConflictLogging	boolean	如果启用了冲突日志记录。
properties.hubDatabasePassword	string	同步组中心数据库凭据的密码。
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 的名称和容量。
type	string	资源类型。

SyncGroupSchema

Object

同步组架构的属性。

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

SyncGroupSchemaTable

Object

同步组架构中表的属性。

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

SyncGroupSchemaTableColumn

Object

同步组表中列的属性。

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

SyncGroupState

枚举

同步组的同步状态。

值	说明
NotReady
Error
Warning
Progressing
Good

通过

Sync Groups - Create Or Update

URI 参数

请求正文

响应

示例

Create a sync group

示例请求

示例响应

Update a sync group

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState