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 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	同步群組裝載所在的資料庫名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
syncGroupName	path	True	string	同步群組的名稱。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	類型	Description
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 資源識別碼。
properties.usePrivateLinkConnection	boolean	如果已啟用使用私人連結連線。
sku	Sku	SKU 的名稱和容量。

回應

名稱	類型	Description
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 不符ResourceGroupNameWithUrl - 提供的資源組名不符合 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 - 無法在數據同步中使用 datawarehouse 版本。 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 - 標識符為的作業不存在。 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://learn.microsoft.com/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://learn.microsoft.com/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

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Sku	ARM 資源 SKU。
SyncConflictResolutionPolicy	同步群組的衝突解決原則。
SyncGroup	Azure SQL Database 同步群組。
SyncGroupSchema	同步群組架構的屬性。
SyncGroupSchemaTable	同步群組架構中數據表的屬性。
SyncGroupSchemaTableColumn	同步群組數據表中數據行的屬性。
SyncGroupState	同步群組的同步狀態。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

Sku

Object

ARM 資源 SKU。

名稱	類型	Description
capacity	integer (int32)	特定 SKU 的容量。
family	string	如果服務有不同世代的硬體，針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱，通常是字母 + 數位碼，例如 P3。
size	string	特定 SKU 的大小
tier	string	特定 SKU 的階層或版本，例如基本、進階。

SyncConflictResolutionPolicy

列舉型別

同步群組的衝突解決原則。

值	Description
HubWin
MemberWin

SyncGroup

Object

Azure SQL Database 同步群組。

名稱	類型	Description
id	string	資源標識碼。
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 資源識別碼。
properties.syncState	SyncGroupState	同步群組的同步狀態。
properties.usePrivateLinkConnection	boolean	如果已啟用使用私人連結連線。
sku	Sku	SKU 的名稱和容量。
type	string	資源類型。

SyncGroupSchema

Object

同步群組架構的屬性。

名稱	類型	Description
masterSyncMemberName	string	架構的來源主要同步處理成員名稱。
tables	SyncGroupSchemaTable[]	同步群組架構中的數據表清單。

SyncGroupSchemaTable

Object

同步群組架構中數據表的屬性。

名稱	類型	Description
columns	SyncGroupSchemaTableColumn[]	同步群組架構中的數據行清單。
quotedName	string	同步群組架構數據表的引號名稱。

SyncGroupSchemaTableColumn

Object

同步群組數據表中數據行的屬性。

名稱	類型	Description
dataSize	string	數據行的數據大小。
dataType	string	數據行的數據類型。
quotedName	string	同步群組數據表數據行的引號名稱。

SyncGroupState

列舉型別

同步群組的同步狀態。

值	Description
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