Sync Members - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?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 sur lequel le membre de synchronisation est hébergé.
syncMemberName	path	True	string	Nom du membre de synchronisation.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.databaseName	string	Nom de la base de données membre dans le membre de synchronisation.
properties.databaseType	SyncMemberDbType	Type de base de données du membre de synchronisation.
properties.password	string	Mot de passe de la base de données membre dans le membre de synchronisation.
properties.serverName	string	Nom du serveur de la base de données membre dans le membre de synchronisation
properties.sqlServerDatabaseId	string	SQL Server’ID de base de données du membre de synchronisation.
properties.syncAgentId	string	ID de ressource ARM de l’agent de synchronisation dans le membre de synchronisation.
properties.syncDirection	SyncDirection	Direction de synchronisation du membre de synchronisation.
properties.syncMemberAzureDatabaseResourceId	string	ID de ressource ARM de la base de données logique des membres de synchronisation, pour les membres de synchronisation dans Azure.
properties.usePrivateLinkConnection	boolean	Indique s’il faut utiliser une connexion de liaison privée.
properties.userName	string	Nom d’utilisateur de la base de données membre dans le membre de synchronisation.

Réponses

Nom	Type	Description
200 OK	SyncMember	Mise à jour réussie du membre de synchronisation.
201 Created	SyncMember	Le membre de synchronisation a été créé.
202 Accepted		La création ou la mise à jour du membre 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 InvalidSyncMember : le membre de synchronisation n’est pas valide. 400 InvalidSyncAgent : l’agent de synchronisation n’est pas valide. 400 CannotCreateSyncMemberDueToQuotaExceeded : impossible de créer un membre de synchronisation en raison d’un quota dépassé. 400 SyncOperation_DuplicateSyncMemberDrop : le membre 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_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. 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_DuplicateSyncMemberName : impossible de créer un membre de synchronisation, car le membre 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 new sync member

Update a sync member

Create a new sync member

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/syncMembers/syncmembercrud-4879?api-version=2021-11-01

{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "usePrivateLinkConnection": true,
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncMemberInner;
import com.azure.resourcemanager.sql.models.SyncDirection;
import com.azure.resourcemanager.sql.models.SyncMemberDbType;

/** Samples for SyncMembers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncMemberCreate.json
     */
    /**
     * Sample code: Create a new sync member.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createANewSyncMember(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncMembers().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", "syncmembercrud-4879",
            new SyncMemberInner().withDatabaseType(SyncMemberDbType.AZURE_SQL_DATABASE)
                .withSyncMemberAzureDatabaseResourceId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withUsePrivateLinkConnection(true).withServerName("syncgroupcrud-3379.database.windows.net")
                .withDatabaseName("syncgroupcrud-7421").withUsername("myUser")
                .withSyncDirection(SyncDirection.BIDIRECTIONAL),
            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": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

Status code:: 201

{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

Status code:: 202

Update a sync member

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/syncMembers/syncmembercrud-4879?api-version=2021-11-01

{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "usePrivateLinkConnection": true,
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SyncMemberInner;
import com.azure.resourcemanager.sql.models.SyncDirection;
import com.azure.resourcemanager.sql.models.SyncMemberDbType;

/** Samples for SyncMembers CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncMemberUpdate.json
     */
    /**
     * Sample code: Update a sync member.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncMember(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncMembers().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", "syncmembercrud-4879",
            new SyncMemberInner().withDatabaseType(SyncMemberDbType.AZURE_SQL_DATABASE)
                .withSyncMemberAzureDatabaseResourceId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withUsePrivateLinkConnection(true).withServerName("syncgroupcrud-3379.database.windows.net")
                .withDatabaseName("syncgroupcrud-7421").withUsername("myUser")
                .withSyncDirection(SyncDirection.BIDIRECTIONAL),
            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": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

Status code:: 201

{
  "properties": {
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "databaseName": "syncgroupcrud-7421",
    "userName": "myUser",
    "syncDirection": "Bidirectional",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}

Status code:: 202

Définitions

Nom	Description
SyncDirection	Direction de synchronisation du membre de synchronisation.
SyncMember	Membre de synchronisation de base de données Azure SQL.
SyncMemberDbType	Type de base de données du membre de synchronisation.
SyncMemberState	Synchroniser l’état du membre de synchronisation.

SyncDirection

Direction de synchronisation du membre de synchronisation.

Nom	Type	Description
Bidirectional	string
OneWayHubToMember	string
OneWayMemberToHub	string

SyncMember

Membre 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.databaseName	string	Nom de la base de données membre dans le membre de synchronisation.
properties.databaseType	SyncMemberDbType	Type de base de données du membre de synchronisation.
properties.password	string	Mot de passe de la base de données membre dans le membre de synchronisation.
properties.privateEndpointName	string	Nom du point de terminaison privé du membre de synchronisation si l’utilisation de la connexion de liaison privée est activée, pour les membres de synchronisation dans Azure.
properties.serverName	string	Nom du serveur de la base de données membre dans le membre de synchronisation
properties.sqlServerDatabaseId	string	SQL Server’ID de base de données du membre de synchronisation.
properties.syncAgentId	string	ID de ressource ARM de l’agent de synchronisation dans le membre de synchronisation.
properties.syncDirection	SyncDirection	Direction de synchronisation du membre de synchronisation.
properties.syncMemberAzureDatabaseResourceId	string	ID de ressource ARM de la base de données logique des membres de synchronisation, pour les membres de synchronisation dans Azure.
properties.syncState	SyncMemberState	Synchroniser l’état du membre de synchronisation.
properties.usePrivateLinkConnection	boolean	Indique s’il faut utiliser une connexion de liaison privée.
properties.userName	string	Nom d’utilisateur de la base de données membre dans le membre de synchronisation.
type	string	Type de ressource.

SyncMemberDbType

Type de base de données du membre de synchronisation.

Nom	Type	Description
AzureSqlDatabase	string
SqlServerDatabase	string

SyncMemberState

Synchroniser l’état du membre de synchronisation.

Nom	Type	Description
DeProvisionFailed	string
DeProvisioned	string
DeProvisioning	string
DisabledBackupRestore	string
DisabledTombstoneCleanup	string
ProvisionFailed	string
Provisioned	string
Provisioning	string
ReprovisionFailed	string
Reprovisioning	string
SyncCancelled	string
SyncCancelling	string
SyncFailed	string
SyncInProgress	string
SyncSucceeded	string
SyncSucceededWithWarnings	string
UnProvisioned	string
UnReprovisioned	string

Sync Members - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Create a new sync member

Sample Request

Sample Response

Update a sync member

Sample Request

Sample Response

Définitions

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

Ressources supplémentaires