Sync Members - Create Or Update

Service:: SQL Database

API Version:: 2025-01-01

Creates or updates a sync member.

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
syncGroupName	path	True	string	The name of the sync group.
syncMemberName	path	True	string	The name of the sync member.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.databaseName	string	Database name of the member database in the sync member.
properties.databaseType	SyncMemberDbType	Database type of the sync member.
properties.password	string	Password of the member database in the sync member.
properties.serverName	string	Server name of the member database in the sync member
properties.sqlServerDatabaseId	string (uuid)	SQL Server database id of the sync member.
properties.syncAgentId	string	ARM resource id of the sync agent in the sync member.
properties.syncDirection	SyncDirection	Sync direction of the sync member.
properties.syncMemberAzureDatabaseResourceId	string	ARM resource id of the sync member logical database, for sync members in Azure.
properties.usePrivateLinkConnection	boolean	Whether to use private link connection.
properties.userName	string	User name of the member database in the sync member.

Responses

Name	Type	Description
200 OK	SyncMember	Resource 'SyncMember' update operation succeeded
201 Created	SyncMember	Resource 'SyncMember' create operation succeeded Headers Location: string Retry-After: integer
202 Accepted		Resource operation accepted. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create a new sync member

Update a sync member

Create a new sync member

Sample request

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

Sample response

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

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

Status code:: 202

Update a sync member

Sample request

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

Sample response

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

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

Status code:: 202

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SyncDirection	Sync direction of the sync member.
SyncMember	An Azure SQL Database sync member.
SyncMemberDbType	Type of the sync agent linked database.
SyncMemberState	Sync state of the sync member.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SyncDirection

Enumeration

Sync direction of the sync member.

Value	Description
Bidirectional	Bidirectional
OneWayMemberToHub	OneWayMemberToHub
OneWayHubToMember	OneWayHubToMember

SyncMember

Object

An Azure SQL Database sync member.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.databaseName	string	Database name of the member database in the sync member.
properties.databaseType	SyncMemberDbType	Database type of the sync member.
properties.password	string	Password of the member database in the sync member.
properties.privateEndpointName	string	Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
properties.serverName	string	Server name of the member database in the sync member
properties.sqlServerDatabaseId	string (uuid)	SQL Server database id of the sync member.
properties.syncAgentId	string	ARM resource id of the sync agent in the sync member.
properties.syncDirection	SyncDirection	Sync direction of the sync member.
properties.syncMemberAzureDatabaseResourceId	string	ARM resource id of the sync member logical database, for sync members in Azure.
properties.syncState	SyncMemberState	Sync state of the sync member.
properties.usePrivateLinkConnection	boolean	Whether to use private link connection.
properties.userName	string	User name of the member database in the sync member.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SyncMemberDbType

Enumeration

Type of the sync agent linked database.

Value	Description
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

Enumeration

Sync state of the sync member.

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

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Sync Members - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create a new sync member

Sample request

Sample response

Update a sync member

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

systemData