Sync Groups - Create Or Update

Servizio:

SQL Database

Versione API:

2023-08-01

Crea o aggiorna un gruppo di sincronizzazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
databaseName	path	True	string	Nome del database in cui è ospitato il gruppo di sincronizzazione.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serverName	path	True	string	Nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
syncGroupName	path	True	string	Nome del gruppo di sincronizzazione.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.conflictLoggingRetentionInDays	integer (int32)	Periodo di conservazione della registrazione dei conflitti.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Criteri di risoluzione dei conflitti del gruppo di sincronizzazione.
properties.enableConflictLogging	boolean	Se la registrazione dei conflitti è abilitata.
properties.hubDatabasePassword	string	Password per le credenziali del database dell'hub del gruppo di sincronizzazione.
properties.hubDatabaseUserName	string	Nome utente per le credenziali del database dell'hub del gruppo di sincronizzazione.
properties.interval	integer (int32)	Intervallo di sincronizzazione del gruppo di sincronizzazione.
properties.schema	SyncGroupSchema	Schema di sincronizzazione del gruppo di sincronizzazione.
properties.syncDatabaseId	string	ID risorsa ARM del database di sincronizzazione nel gruppo di sincronizzazione.
properties.usePrivateLinkConnection	boolean	Se si usa la connessione di collegamento privato è abilitata.
sku	Sku	Nome e capacità dello SKU.

Risposte

Nome	Tipo	Descrizione
200 OK	SyncGroup	Aggiornamento corretto del gruppo di sincronizzazione.
201 Created	SyncGroup	Il gruppo di sincronizzazione è stato creato correttamente.
202 Accepted		La creazione o l'aggiornamento del gruppo di sincronizzazione è in corso. Intestazioni Location: string
Other Status Codes	ErrorResponse	Risposte di errore: 400 InvalidSyncGroupCreateOrUpdateRequest: il corpo della richiesta del gruppo di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidSyncMemberCreateOrUpdateRequest- Il corpo della richiesta del membro di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidSyncAgentCreateOrUpdateRequest: il corpo della richiesta dell'agente di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidDatabaseResourceId - Identificatore di risorsa di database non valido. 400 InvalidSyncGroupName - Il nome del gruppo di sincronizzazione non è valido. Questo campo può contenere lettere, numeri, trattini e caratteri di sottolineatura. 400 InvalidSyncMemberName- Il nome del membro di sincronizzazione non è valido. Questo campo può contenere lettere, numeri, trattini e caratteri di sottolineatura. 400 MissingSyncMemberName - Manca il nome del membro di sincronizzazione 400 InvalidSyncGroupInterval: l'intervallo di sincronizzazione deve essere maggiore o uguale a 5 secondi. 400 Mancata corrispondenzaSubscriptionWithUrl: la sottoscrizione specificata non corrisponde alla sottoscrizione nell'URL. 400 InvalidSyncAgentResourceId - Identificatore di risorsa dell'agente di sincronizzazione non valido. 400 Mancata corrispondenzaResourceGroupNameWithUrl- Il nome del gruppo di risorse specificato non corrisponde al nome nell'URL. 400 MismatchingServerNameWithUrl: il nome del server specificato non corrisponde al nome nell'URL. 400 InvalidParameterValue- È stato assegnato un valore non valido a un parametro. 400 MissingServerName - Manca il nome del server 400 MissingDatabaseName - Nome database mancante 400 MissingSyncGroupName - Manca il nome del gruppo di sincronizzazione 400 MissingConflictResolutionPolicy - Manca il criterio di risoluzione dei conflitti 400 MissingSyncAgentName - Manca il nome dell'agente di sincronizzazione 400 SyncOperation_GenericFailure - Impossibile eseguire l'operazione di sincronizzazione dei dati. 400 InvalidSyncGroup - Il gruppo di sincronizzazione non è valido. 400 FeatureDisabledOnSelectedEdition : l'utente ha tentato di usare una funzionalità disabilitata nell'edizione del database corrente. 400 CannotCreateSyncGroupDueToQuotaExceeded - Impossibile creare un gruppo di sincronizzazione a causa del superamento della quota. 400 SyncOperation_DuplicateSyncGroupDrop : il gruppo di sincronizzazione è già stato eliminato. 400 SyncOperation_WrongSyncDatabase: il database di sincronizzazione specificato non corrisponde a quello esistente. 400 SyncOperation_UpdateSyncGroupWhenDropping - Impossibile aggiornare il gruppo di sincronizzazione perché è in corso l'eliminazione. 400 SyncOperation_DwInSyncGroup - Non è possibile usare l'edizione datawarehouse nella sincronizzazione dati. 400 SyncOperation_MasterDbInSyncGroup : non è possibile usare il master logico nella sincronizzazione dati. 400 SyncOperation_UnsupportedDataTypeColumnInSchema - Impossibile aggiungere colonna allo schema perché il tipo di dati della colonna non è supportato. 400 SyncOperation_InvalidCredential: le credenziali del database non sono valide. 400 InvalidSyncMetadataDatabase - Il database dei metadati di sincronizzazione non è valido. 400 SyncOperation_InvalidSyncInterval - Impossibile creare o aggiornare il gruppo di sincronizzazione perché l'intervallo di sincronizzazione non è valido. 404 ResourceNotFound: la risorsa richiesta non è stata trovata. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 DatabaseDoesNotExist: l'utente ha specificato un nome di database che non esiste in questa istanza del server. 404 SyncOperation_HubServerNotFound - Il server logico hub non esiste. 404 SyncOperation_InvalidHubDatabase - Database hub non valido. 404 OperationIdNotFound - L'operazione con ID non esiste. 409 SyncOperation_DuplicateSyncGroupName - Impossibile creare un gruppo di sincronizzazione perché il gruppo di sincronizzazione con lo stesso nome esiste già. 409 CannotCancelOperation: l'operazione di gestione si trova in uno stato che non può essere annullato. 409 OperationCancelled - L'operazione è stata annullata dall'utente. 409 OperationInterrupted - Impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa. 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 500 OperationTimedOut: timeout dell'operazione e rollback automatico. Ripetere l'operazione. 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

Create a sync group

Update a sync group

Create a sync group

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

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"
}

Codice di stato:

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"
}

Codice di stato:

202

Update a sync group

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:

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"
}

Codice di stato:

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"
}

Codice di stato:

202

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
Sku	SKU della risorsa ARM.
SyncConflictResolutionPolicy	Criteri di risoluzione dei conflitti del gruppo di sincronizzazione.
SyncGroup	Un gruppo di sincronizzazione del database SQL di Azure.
SyncGroupSchema	Proprietà dello schema del gruppo di sincronizzazione.
SyncGroupSchemaTable	Proprietà della tabella nello schema del gruppo di sincronizzazione.
SyncGroupSchemaTableColumn	Proprietà della colonna nella tabella del gruppo di sincronizzazione.
SyncGroupState	Stato di sincronizzazione del gruppo di sincronizzazione.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Sku

Object

SKU della risorsa ARM.

Nome	Tipo	Descrizione
capacity	integer (int32)	Capacità dello SKU specifico.
family	string	Se il servizio ha generazioni diverse di hardware, per lo stesso SKU, è possibile acquisire qui.
name	string	Il nome dello SKU, in genere, una lettera + codice numerico, ad esempio P3.
size	string	Dimensioni dello SKU specifico
tier	string	Il livello o l'edizione dello SKU specifico, ad esempio Basic, Premium.

SyncConflictResolutionPolicy

Enumerazione

Criteri di risoluzione dei conflitti del gruppo di sincronizzazione.

Valore	Descrizione
HubWin
MemberWin

SyncGroup

Object

Un gruppo di sincronizzazione del database SQL di Azure.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.conflictLoggingRetentionInDays	integer (int32)	Periodo di conservazione della registrazione dei conflitti.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Criteri di risoluzione dei conflitti del gruppo di sincronizzazione.
properties.enableConflictLogging	boolean	Se la registrazione dei conflitti è abilitata.
properties.hubDatabasePassword	string	Password per le credenziali del database dell'hub del gruppo di sincronizzazione.
properties.hubDatabaseUserName	string	Nome utente per le credenziali del database dell'hub del gruppo di sincronizzazione.
properties.interval	integer (int32)	Intervallo di sincronizzazione del gruppo di sincronizzazione.
properties.lastSyncTime	string (date-time)	Ora dell'ultima sincronizzazione del gruppo di sincronizzazione.
properties.privateEndpointName	string	Nome dell'endpoint privato del gruppo di sincronizzazione se si usa la connessione di collegamento privato è abilitata.
properties.schema	SyncGroupSchema	Schema di sincronizzazione del gruppo di sincronizzazione.
properties.syncDatabaseId	string	ID risorsa ARM del database di sincronizzazione nel gruppo di sincronizzazione.
properties.syncState	SyncGroupState	Stato di sincronizzazione del gruppo di sincronizzazione.
properties.usePrivateLinkConnection	boolean	Se si usa la connessione di collegamento privato è abilitata.
sku	Sku	Nome e capacità dello SKU.
type	string	Tipo di risorsa.

SyncGroupSchema

Object

Proprietà dello schema del gruppo di sincronizzazione.

Nome	Tipo	Descrizione
masterSyncMemberName	string	Nome del membro di sincronizzazione master da cui proviene lo schema.
tables	SyncGroupSchemaTable[]	Elenco di tabelle nello schema del gruppo di sincronizzazione.

SyncGroupSchemaTable

Object

Proprietà della tabella nello schema del gruppo di sincronizzazione.

Nome	Tipo	Descrizione
columns	SyncGroupSchemaTableColumn[]	Elenco di colonne nello schema del gruppo di sincronizzazione.
quotedName	string	Nome delimitato della tabella dello schema del gruppo di sincronizzazione.

SyncGroupSchemaTableColumn

Object

Proprietà della colonna nella tabella del gruppo di sincronizzazione.

Nome	Tipo	Descrizione
dataSize	string	Dimensioni dei dati della colonna.
dataType	string	Tipo di dati della colonna.
quotedName	string	Nome delimitato della colonna della tabella del gruppo di sincronizzazione.

SyncGroupState

Enumerazione

Stato di sincronizzazione del gruppo di sincronizzazione.

Valore	Descrizione
NotReady
Error
Warning
Progressing
Good