Sync Groups - Create Or Update

參考

服務:: SQL Database

API 版本:: 2021-11-01

建立或更新同步群組。

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

URI 參數

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

要求本文

名稱	類型	Description
properties.conflictLoggingRetentionInDays	integer	衝突記錄保留期間。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同步群組的衝突解決原則。
properties.enableConflictLogging	boolean	如果已啟用衝突記錄。
properties.hubDatabasePassword	string	同步群組中樞資料庫認證的密碼。
properties.hubDatabaseUserName	string	同步群組中樞資料庫認證的用戶名稱。
properties.interval	integer	同步群組的同步間隔。
properties.schema	SyncGroupSchema	同步群組的同步架構。
properties.syncDatabaseId	string	同步群組中同步資料庫的 ARM 資源識別碼。
properties.usePrivateLinkConnection	boolean	如果已啟用使用私人連結連線。
sku	Sku	SKU 的名稱和容量。

回應

名稱	類型	Description
200 OK	SyncGroup	已成功更新同步群組。
201 Created	SyncGroup	已成功建立同步群組。
202 Accepted		正在建立或更新同步群組。
Other Status Codes		錯誤回應： ≦ 400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。 400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。 400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。 400 InvalidDatabaseResourceId - 無效的資料庫資源標識符。 400 不符SubscriptionWithUrl - 提供的訂用帳戶不符合 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_InvalidCredential - 資料庫的認證無效。 400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。 400 SyncOperation_InvalidSyncInterval - 無法建立或更新同步群組，因為同步間隔無效。 404 ResourceNotFound - 找不到所要求的資源。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定不存在於此伺服器實例上的資料庫名稱。 404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。 404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。 404 OperationIdNotFound - 標識符為的作業不存在。 409 SyncOperation_DuplicateSyncGroupName - 無法建立同步群組，因為具有相同名稱的同步群組已經存在。 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=2021-11-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
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncGroupInner;
import com.azure.resourcemanager.sql.models.SyncConflictResolutionPolicy;

/**
 * Samples for SyncGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupCreate.json
     */
    /**
     * Sample code: Create a sync group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            com.azure.core.util.Context.NONE);
    }
}

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
Java

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=2021-11-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
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncGroupInner;
import com.azure.resourcemanager.sql.models.SyncConflictResolutionPolicy;

/**
 * Samples for SyncGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupUpdate.json
     */
    /**
     * Sample code: Update a sync group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187",
            new SyncGroupInner().withInterval(-1).withConflictResolutionPolicy(SyncConflictResolutionPolicy.HUB_WIN)
                .withSyncDatabaseId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withHubDatabaseUsername("hubUser").withUsePrivateLinkConnection(true),
            com.azure.core.util.Context.NONE);
    }
}

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
Sku	ARM 資源 SKU。
SyncConflictResolutionPolicy	同步群組的衝突解決原則。
SyncGroup	Azure SQL 資料庫同步群組。
SyncGroupSchema	同步群組架構的屬性。
SyncGroupSchemaTable	同步群組架構中數據表的屬性。
SyncGroupSchemaTableColumn	同步群組數據表中數據行的屬性。
SyncGroupState	同步群組的同步狀態。

Sku

ARM 資源 SKU。

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

SyncConflictResolutionPolicy

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

名稱	類型	Description
HubWin	string
MemberWin	string

SyncGroup

Azure SQL 資料庫同步群組。

名稱	類型	Description
id	string	資源識別碼。
name	string	資源名稱。
properties.conflictLoggingRetentionInDays	integer	衝突記錄保留期間。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同步群組的衝突解決原則。
properties.enableConflictLogging	boolean	如果已啟用衝突記錄。
properties.hubDatabasePassword	string	同步群組中樞資料庫認證的密碼。
properties.hubDatabaseUserName	string	同步群組中樞資料庫認證的用戶名稱。
properties.interval	integer	同步群組的同步間隔。
properties.lastSyncTime	string	同步群組的上次同步時間。
properties.privateEndpointName	string	如果已啟用私人連結連線，同步群組的私人端點名稱。
properties.schema	SyncGroupSchema	同步群組的同步架構。
properties.syncDatabaseId	string	同步群組中同步資料庫的 ARM 資源識別碼。
properties.syncState	SyncGroupState	同步群組的同步狀態。
properties.usePrivateLinkConnection	boolean	如果已啟用使用私人連結連線。
sku	Sku	SKU 的名稱和容量。
type	string	資源類型。

SyncGroupSchema

同步群組架構的屬性。

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

SyncGroupSchemaTable

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

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

SyncGroupSchemaTableColumn

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

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

SyncGroupState

同步群組的同步狀態。

名稱	類型	Description
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

共用方式為

Sync Groups - Create Or Update

URI 參數

要求本文

回應

範例

Create a sync group

範例要求

範例回覆

Update a sync group

範例要求

範例回覆

定義

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

其他資源