Sync Groups - Create Or Update

Service:: SQL Database

Version d'API:: 2025-01-01

Crée ou met à jour un groupe de synchronisation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
syncGroupName	path	True	string	Nom du groupe de synchronisation.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.conflictLoggingRetentionInDays	integer (int32)	Période de rétention de journalisation des conflits.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Stratégie de résolution des conflits du groupe de synchronisation.
properties.enableConflictLogging	boolean	Si la journalisation des conflits est activée.
properties.hubDatabasePassword	string (password)	Mot de passe pour les informations d’identification de la base de données hub de groupe de synchronisation.
properties.hubDatabaseUserName	string	Nom d’utilisateur pour les informations d’identification de la base de données hub de groupe de synchronisation.
properties.interval	integer (int32)	Intervalle de synchronisation du groupe de synchronisation.
properties.schema	SyncGroupSchema	Schéma de synchronisation du groupe de synchronisation.
properties.syncDatabaseId	string	ID de ressource ARM de la base de données de synchronisation dans le groupe de synchronisation.
properties.usePrivateLinkConnection	boolean	Si vous utilisez la connexion de liaison privée est activée.
sku	Sku	Nom et capacité de la référence SKU.

Réponses

Nom	Type	Description
200 OK	SyncGroup	Opération de mise à jour de la ressource 'SyncGroup' réussie
201 Created	SyncGroup	Ressource 'SyncGroup' création d’opération réussie En-têtes Location: string Retry-After: integer
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create a sync group

Update a sync group

Create a sync group

Exemple de requête

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=2025-01-01

{
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true
  }
}

Exemple de réponse

Code d’état:: 200

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

Code d’état:: 201

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

Code d’état:: 202

Update a sync group

Exemple de requête

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=2025-01-01

{
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true
  }
}

Exemple de réponse

Code d’état:: 200

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

Code d’état:: 201

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

Code d’état:: 202

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Sku	Référence SKU de ressource ARM.
SyncConflictResolutionPolicy	Stratégie de résolution des conflits du groupe de synchronisation.
SyncGroup	Un groupe de synchronisation Azure SQL Database.
SyncGroupSchema	Propriétés du schéma de groupe de synchronisation.
SyncGroupSchemaTable	Propriétés de la table dans le schéma de groupe de synchronisation.
SyncGroupSchemaTableColumn	Propriétés de la colonne dans la table de groupe de synchronisation.
SyncGroupState	État de synchronisation du groupe de synchronisation.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Sku

Objet

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer (int32)	Capacité de la référence SKU particulière.
family	string	Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici.
name	string	Nom de la référence SKU, généralement une lettre + code numérique, par exemple P3.
size	string	Taille de la référence SKU particulière
tier	string	Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.

SyncConflictResolutionPolicy

Énumération

Stratégie de résolution des conflits du groupe de synchronisation.

Valeur	Description
HubWin	HubWin
MemberWin	MemberWin

SyncGroup

Objet

Un groupe de synchronisation Azure SQL Database.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.conflictLoggingRetentionInDays	integer (int32)	Période de rétention de journalisation des conflits.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Stratégie de résolution des conflits du groupe de synchronisation.
properties.enableConflictLogging	boolean	Si la journalisation des conflits est activée.
properties.hubDatabasePassword	string (password)	Mot de passe pour les informations d’identification de la base de données hub de groupe de synchronisation.
properties.hubDatabaseUserName	string	Nom d’utilisateur pour les informations d’identification de la base de données hub de groupe de synchronisation.
properties.interval	integer (int32)	Intervalle de synchronisation du groupe de synchronisation.
properties.lastSyncTime	string (date-time)	Heure de la dernière synchronisation du groupe de synchronisation.
properties.privateEndpointName	string	Nom du point de terminaison privé du groupe de synchronisation si la connexion de liaison privée est activée.
properties.schema	SyncGroupSchema	Schéma de synchronisation du groupe de synchronisation.
properties.syncDatabaseId	string	ID de ressource ARM de la base de données de synchronisation dans le groupe de synchronisation.
properties.syncState	SyncGroupState	État de synchronisation du groupe de synchronisation.
properties.usePrivateLinkConnection	boolean	Si vous utilisez la connexion de liaison privée est activée.
sku	Sku	Nom et capacité de la référence SKU.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

SyncGroupSchema

Objet

Propriétés du schéma de groupe de synchronisation.

Nom	Type	Description
masterSyncMemberName	string	Nom du membre de synchronisation maître à partir duquel le schéma provient.
tables	SyncGroupSchemaTable[]	Liste des tables dans le schéma de groupe de synchronisation.

SyncGroupSchemaTable

Objet

Propriétés de la table dans le schéma de groupe de synchronisation.

Nom	Type	Description
columns	SyncGroupSchemaTableColumn[]	Liste des colonnes dans le schéma de groupe de synchronisation.
quotedName	string	Nom entre guillemets de la table de schéma de groupe de synchronisation.

SyncGroupSchemaTableColumn

Objet

Propriétés de la colonne dans la table de groupe de synchronisation.

Nom	Type	Description
dataSize	string	Taille des données de la colonne.
dataType	string	Type de données de la colonne.
quotedName	string	Nom entre guillemets de la colonne de table de groupe de synchronisation.

SyncGroupState

Énumération

État de synchronisation du groupe de synchronisation.

Valeur	Description
NotReady	NotReady
Error	Error
Warning	Avertissement
Progressing	Progression
Good	Bien

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.