Sync Members - Create Or Update

Service:: SQL Database

Version d'API:: 2025-01-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=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.
syncMemberName	path	True	string	Nom du membre 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.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 (uuid)	ID de base de données SQL Server du membre de sync.
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	Opération de mise à jour de la ressource 'SyncMember' réussie
201 Created	SyncMember	Ressource 'SyncMember' créer l’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 new sync member

Update a sync member

Create a new sync member

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

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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 201

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

Code d’état:: 202

Update a sync member

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

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

Exemple de réponse

Code d’état:: 200

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

Code d’état:: 201

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

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
SyncDirection	Direction de synchronisation du membre de synchronisation.
SyncMember	Un membre de synchronisation Azure SQL Database.
SyncMemberDbType	Type de la base de données liée de l’agent de synchronisation.
SyncMemberState	État de synchronisation du membre 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.

SyncDirection

Énumération

Direction de synchronisation du membre de synchronisation.

Valeur	Description
Bidirectional	Bidirectionnel
OneWayMemberToHub	OneWayMemberToHub
OneWayHubToMember	OneWayHubToMember

SyncMember

Objet

Un membre 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.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	Le nom du point de terminaison privé du membre de synchronisation si la connexion de lien privé est activé, 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 (uuid)	ID de base de données SQL Server du membre de sync.
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	État de synchronisation 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.
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"

SyncMemberDbType

Énumération

Type de la base de données liée de l’agent de synchronisation.

Valeur	Description
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

Énumération

État de synchronisation du membre de synchronisation.

Valeur	Description
SyncInProgress	SyncInProgress
SyncSucceeded	SyncSucceeded
SyncFailed	SyncFailed
DisabledTombstoneCleanup	DésactivéTombstoneCleanup
DisabledBackupRestore	DisabledBackupRestore
SyncSucceededWithWarnings	SyncSucceededWithWarnings
SyncCancelling	SyncCancelling
SyncCancelled	SyncCancelled
UnProvisioned	Non Provisionné
Provisioning	Provisioning
Provisioned	provisionné
ProvisionFailed	ProvisionFailed
DeProvisioning	Déprovisionnement
DeProvisioned	DeProvisionné
DeProvisionFailed	DeProvisionFailed
Reprovisioning	Réapprovisionnement
ReprovisionFailed	Ravitaillement échoué
UnReprovisioned	Non réapprovisionné

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.

Partager via

Sync Members - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create a new sync member

Exemple de requête

Exemple de réponse

Update a sync member

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

systemData