Sync Groups - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-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=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données sur laquelle le groupe de synchronisation est hébergé.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
syncGroupName	path	True	string	Nom du groupe de synchronisation.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.conflictLoggingRetentionInDays	integer	Période de rétention de la 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	Mot de passe pour les informations d’identification de la base de données hub du groupe de synchronisation.
properties.hubDatabaseUserName	string	Nom d’utilisateur pour les informations d’identification de la base de données hub du groupe de synchronisation.
properties.interval	integer	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 l’utilisation de la connexion privée est activée.
sku	Sku	Nom et capacité de la référence SKU.

Réponses

Nom	Type	Description
200 OK	SyncGroup	Mise à jour réussie du groupe de synchronisation.
201 Created	SyncGroup	Le groupe de synchronisation a été créé.
202 Accepted		La création ou la mise à jour du groupe de synchronisation est en cours.
Other Status Codes		Réponses d’erreur : *** 400 InvalidSyncGroupCreateOrUpdateRequest : le corps de la demande de groupe de synchronisation de création ou de mise à jour est vide. 400 InvalidSyncMemberCreateOrUpdateRequest : le corps de la demande de membre de synchronisation de création ou de mise à jour est vide. 400 InvalidSyncAgentCreateOrUpdateRequest : le corps de la demande de l’agent de synchronisation de création ou de mise à jour est vide. 400 InvalidDatabaseResourceId : identificateur de ressource de base de données non valide. 400 MismatchingSubscriptionWithUrl : l’abonnement fourni ne correspond pas à l’abonnement dans l’URL. 400 InvalidSyncAgentResourceId : identificateur de ressource de l’agent de synchronisation non valide. 400 Non correspondanceResourceGroupNameWithUrl : le nom du groupe de ressources fourni ne correspond pas au nom dans l’URL. 400 MismatchingServerNameWithUrl : le nom du serveur fourni ne correspond pas au nom dans l’URL. 400 InvalidParameterValue : une valeur non valide a été donnée à un paramètre. 400 MissingServerName : le nom du serveur est manquant 400 MissingDatabaseName : le nom de la base de données est manquant 400 MissingSyncGroupName : le nom du groupe de synchronisation est manquant 400 MissingConflictResolutionPolicy : la stratégie de résolution des conflits est manquante 400 MissingSyncAgentName : le nom de l’agent de synchronisation est manquant 400 SyncOperation_GenericFailure : échec de l’opération de synchronisation des données. 400 InvalidSyncGroup : le groupe de synchronisation n’est pas valide. 400 FeatureDisabledOnSelectedEdition : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée sur l’édition actuelle de la base de données. 400 CannotCreateSyncGroupDueToQuotaExceeded : impossible de créer un groupe de synchronisation en raison d’un quota dépassé. 400 SyncOperation_DuplicateSyncGroupDrop : le groupe de synchronisation est déjà supprimé. 400 SyncOperation_WrongSyncDatabase : la base de données de synchronisation spécifiée ne correspond pas à la base de données existante. 400 SyncOperation_UpdateSyncGroupWhenDropping : impossible de mettre à jour le groupe de synchronisation, car il est en cours de suppression. 400 SyncOperation_DwInSyncGroup : impossible d’utiliser l’édition datawarehouse dans la synchronisation des données. 400 SyncOperation_MasterDbInSyncGroup : impossible d’utiliser des master logiques dans la synchronisation des données. 400 SyncOperation_InvalidCredential : les informations d’identification de la base de données ne sont pas valides. 400 InvalidSyncMetadataDatabase : la base de données de métadonnées de synchronisation n’est pas valide. 400 SyncOperation_InvalidSyncInterval : impossible de créer ou de mettre à jour un groupe de synchronisation, car l’intervalle de synchronisation n’est pas valide. 404 ResourceNotFound : la ressource demandée est introuvable. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 404 SyncOperation_HubServerNotFound : le serveur logique Hub n’existe pas. 404 SyncOperation_InvalidHubDatabase : la base de données hub n’est pas valide. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 SyncOperation_DuplicateSyncGroupName - Impossible de créer un groupe de synchronisation, car le groupe de synchronisation portant le même nom existe déjà. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

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.core.util.Context;
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),
            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

Sample Response

Status code:: 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"
}

Status code:: 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"
}

Status code:: 202

Update a sync group

Sample Request

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.core.util.Context;
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),
            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

Sample Response

Status code:: 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"
}

Status code:: 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"
}

Status code:: 202

Définitions

Nom	Description
Sku	Référence SKU de ressource ARM.
SyncConflictResolutionPolicy	Stratégie de résolution des conflits du groupe de synchronisation.
SyncGroup	Groupe de synchronisation de base de données Azure SQL.
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.

Sku

Référence SKU de ressource ARM.

Nom	Type	Description
capacity	integer	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, cela peut être capturé ici.
name	string	Nom de la référence SKU, généralement une lettre + un 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

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

Nom	Type	Description
HubWin	string
MemberWin	string

SyncGroup

Groupe de synchronisation de base de données Azure SQL.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.conflictLoggingRetentionInDays	integer	Période de rétention de la 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	Mot de passe pour les informations d’identification de la base de données hub du groupe de synchronisation.
properties.hubDatabaseUserName	string	Nom d’utilisateur pour les informations d’identification de la base de données hub du groupe de synchronisation.
properties.interval	integer	Intervalle de synchronisation du groupe de synchronisation.
properties.lastSyncTime	string	Heure de la dernière synchronisation du groupe de synchronisation.
properties.privateEndpointName	string	Nom du point de terminaison privé du groupe de synchronisation si l’utilisation de 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 l’utilisation de la connexion privée est activée.
sku	Sku	Nom et capacité de la référence SKU.
type	string	Type de ressource.

SyncGroupSchema

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

Nom	Type	Description
masterSyncMemberName	string	Nom de master membre de synchronisation d’où provient le schéma.
tables	SyncGroupSchemaTable[]	Liste des tables dans le schéma de groupe de synchronisation.

SyncGroupSchemaTable

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

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

État de synchronisation du groupe de synchronisation.

Nom	Type	Description
Error	string
Good	string
NotReady	string
Progressing	string
Warning	string

Sync Groups - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Create a sync group

Sample Request

Sample Response

Update a sync group

Sample Request

Sample Response

Définitions

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Ressources supplémentaires