Sync Groups - Trigger Sync

Tjänst:: SQL Database

API-version:: 2023-08-01

Utlöser synkronisering av synkroniseringsgrupper.

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-parametrar

Name	I	Obligatorisk	Typ	Description
databaseName	path	True	string	Namnet på databasen där synkroniseringsgruppen finns.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
syncGroupName	path	True	string	Namnet på synkroniseringsgruppen.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK		Har utlöst en synkroniseringsgruppssynkronisering.
Other Status Codes	ErrorResponse	Felsvar: *** 400 InvalidSyncGroupCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsgruppen är tom. 400 InvalidSyncMemberCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsmedlem är tom. 400 InvalidSyncAgentCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsagenten är tom. 400 InvalidDatabaseResourceId – Ogiltig databasresursidentifierare. 400 InvalidSyncGroupName – Namnet på synkroniseringsgruppen är ogiltigt. Det här fältet kan innehålla bokstäver, siffror, bindestreck och understreck. 400 InvalidSyncMemberName – Sync Member-namnet är ogiltigt. Det här fältet kan innehålla bokstäver, siffror, bindestreck och understreck. 400 MissingSyncMemberName – Sync Member-namnet saknas 400 InvalidSyncGroupInterval – Synkroniseringsintervallet ska vara större än eller lika med 5 sekunder. 400 MismatchingSubscriptionWithUrl – Den angivna prenumerationen matchade inte prenumerationen i URL:en. 400 InvalidSyncAgentResourceId – Ogiltig synkroniseringsagentresursidentifierare. 400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en. 400 MismatchingServerNameWithUrl – Det angivna servernamnet matchade inte namnet i URL:en. 400 InvalidParameterValue – ett ogiltigt värde gavs till en parameter. 400 MissingServerName – Servernamnet saknas 400 MissingDatabaseName – Databasnamnet saknas 400 MissingSyncGroupName – Namnet på synkroniseringsgruppen saknas 400 MissingConflictResolutionPolicy – Konfliktlösningsprincipen saknas 400 MissingSyncAgentName – Sync Agent-namnet saknas 400 SyncOperation_GenericFailure – Det gick inte att utföra datasynkronisering. 400 InvalidSyncGroup – synkroniseringsgruppen är ogiltig. 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 CannotCreateSyncGroupDueToQuotaExceededed – Det går inte att skapa synkroniseringsgruppen på grund av att kvoten har överskridits. 400 SyncOperation_DuplicateSyncGroupDrop – Synkroniseringsgruppen tas redan bort. 400 SyncOperation_WrongSyncDatabase – Den angivna synkroniseringsdatabasen matchar inte den befintliga. 400 SyncOperation_UpdateSyncGroupWhenDropping – Det går inte att uppdatera synkroniseringsgruppen eftersom den för närvarande tas bort. 400 SyncOperation_DwInSyncGroup – Det går inte att använda datawarehouse edition i datasynkronisering. 400 SyncOperation_MasterDbInSyncGroup – Det går inte att använda logisk huvudserver i datasynkronisering. 400 SyncOperation_UnsupportedDataTypeColumnInSchema – Det går inte att lägga till kolumnen i schemat eftersom datatypen för kolumnen inte stöds. 400 SyncOperation_InvalidCredential – Databasens autentiseringsuppgifter är ogiltiga. 400 InvalidSyncMetadataDatabase – Databasen för synkroniseringsmetadata är ogiltig. 400 SyncOperation_InvalidSyncInterval – Det går inte att skapa eller uppdatera synkroniseringsgruppen eftersom synkroniseringsintervallet är ogiltigt. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen. 404 SyncOperation_HubServerNotFound – Logisk hubbserver finns inte. 404 SyncOperation_InvalidHubDatabase – Hubbdatabasen är ogiltig. 404 OperationIdNotFound – Åtgärden med ID finns inte. 409 SyncOperation_DuplicateSyncGroupName – Det går inte att skapa synkroniseringsgruppen eftersom synkroniseringsgruppen med samma namn redan finns. 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Name

Typ

Description

200 OK

Har utlöst en synkroniseringsgruppssynkronisering.

Other Status Codes

ErrorResponse

Felsvar: ***

400 InvalidSyncGroupCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsgruppen är tom.
400 InvalidSyncMemberCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsmedlem är tom.
400 InvalidSyncAgentCreateOrUpdateRequest – begärandetexten för att skapa eller uppdatera synkroniseringsagenten är tom.
400 InvalidDatabaseResourceId – Ogiltig databasresursidentifierare.
400 InvalidSyncGroupName – Namnet på synkroniseringsgruppen är ogiltigt. Det här fältet kan innehålla bokstäver, siffror, bindestreck och understreck.
400 InvalidSyncMemberName – Sync Member-namnet är ogiltigt. Det här fältet kan innehålla bokstäver, siffror, bindestreck och understreck.
400 MissingSyncMemberName – Sync Member-namnet saknas
400 InvalidSyncGroupInterval – Synkroniseringsintervallet ska vara större än eller lika med 5 sekunder.
400 MismatchingSubscriptionWithUrl – Den angivna prenumerationen matchade inte prenumerationen i URL:en.
400 InvalidSyncAgentResourceId – Ogiltig synkroniseringsagentresursidentifierare.
400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en.
400 MismatchingServerNameWithUrl – Det angivna servernamnet matchade inte namnet i URL:en.
400 InvalidParameterValue – ett ogiltigt värde gavs till en parameter.
400 MissingServerName – Servernamnet saknas
400 MissingDatabaseName – Databasnamnet saknas
400 MissingSyncGroupName – Namnet på synkroniseringsgruppen saknas
400 MissingConflictResolutionPolicy – Konfliktlösningsprincipen saknas
400 MissingSyncAgentName – Sync Agent-namnet saknas
400 SyncOperation_GenericFailure – Det gick inte att utföra datasynkronisering.
400 InvalidSyncGroup – synkroniseringsgruppen är ogiltig.
400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.
400 CannotCreateSyncGroupDueToQuotaExceededed – Det går inte att skapa synkroniseringsgruppen på grund av att kvoten har överskridits.
400 SyncOperation_DuplicateSyncGroupDrop – Synkroniseringsgruppen tas redan bort.
400 SyncOperation_WrongSyncDatabase – Den angivna synkroniseringsdatabasen matchar inte den befintliga.
400 SyncOperation_UpdateSyncGroupWhenDropping – Det går inte att uppdatera synkroniseringsgruppen eftersom den för närvarande tas bort.
400 SyncOperation_DwInSyncGroup – Det går inte att använda datawarehouse edition i datasynkronisering.
400 SyncOperation_MasterDbInSyncGroup – Det går inte att använda logisk huvudserver i datasynkronisering.
400 SyncOperation_UnsupportedDataTypeColumnInSchema – Det går inte att lägga till kolumnen i schemat eftersom datatypen för kolumnen inte stöds.
400 SyncOperation_InvalidCredential – Databasens autentiseringsuppgifter är ogiltiga.
400 InvalidSyncMetadataDatabase – Databasen för synkroniseringsmetadata är ogiltig.
400 SyncOperation_InvalidSyncInterval – Det går inte att skapa eller uppdatera synkroniseringsgruppen eftersom synkroniseringsintervallet är ogiltigt.
404 ResourceNotFound – Den begärda resursen hittades inte.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 DatabaseDoesNotExist – Användaren har angett ett databasnamn som inte finns på den här serverinstansen.
404 SyncOperation_HubServerNotFound – Logisk hubbserver finns inte.
404 SyncOperation_InvalidHubDatabase – Hubbdatabasen är ogiltig.
404 OperationIdNotFound – Åtgärden med ID finns inte.
409 SyncOperation_DuplicateSyncGroupName – Det går inte att skapa synkroniseringsgruppen eftersom synkroniseringsgruppen med samma namn redan finns.
409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.
409 OperationCancelled – Åtgärden har avbrutits av användaren.
409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.
429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.
500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Trigger a sync group synchronization.

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

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

Exempelsvar

Statuskod:: 200

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Dela via

Sync Groups - Trigger Sync

URI-parametrar

Svar

Exempel

Trigger a sync group synchronization.

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse