Sync Groups - Trigger Sync

服務:

SQL Database

API 版本:

2023-08-01

觸發同步群組同步處理。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/triggerSync?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
200 OK		已成功觸發同步群組同步處理。
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 - 超出可用資源可處理之最大要求的要求。

範例

Trigger a sync group synchronization.

範例要求

HTTP

POST 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/triggerSync?api-version=2023-08-01

dotnet

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/SyncGroupTriggerSync.json
// this example is just showing the usage of "SyncGroups_TriggerSync" 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 SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// invoke the operation
await syncGroup.TriggerSyncAsync();

Console.WriteLine("Succeeded");

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

範例回覆

狀態碼:

200

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

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 物件。