Sync Members - Create Or Update
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=2023-08-01URI Parameters
| Name | In | Required | Type | Description | 
|---|---|---|---|---|
| database | path | True | string | The name of the database on which the sync group is hosted. | 
| resource | path | True | string | The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. | 
| server | path | True | string | The name of the server. | 
| subscription | path | True | string | The subscription ID that identifies an Azure subscription. | 
| sync | path | True | string | The name of the sync group on which the sync member is hosted. | 
| sync | path | True | string | The name of the sync member. | 
| api-version | query | True | string | The API version to use for the request. | 
Request Body
| Name | Type | Description | 
|---|---|---|
| properties.databaseName | string | Database name of the member database in the sync member. | 
| properties.databaseType | 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 | 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 | Successfully updated the sync member. | |
| 201 Created | Successfully created the sync member. | |
| 202 Accepted | Creating or updating the sync member is in progress. Headers Location: string | |
| Other Status Codes | *** Error Responses: *** 
 | 
Examples
| Create a new sync member | 
| Update a sync member | 
Create a new sync member
Sample request
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=2023-08-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"
  }
}
Sample response
{
  "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"
}{
  "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"
}Update a sync member
Sample request
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=2023-08-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"
  }
}
Sample response
{
  "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"
}{
  "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"
}Definitions
| Name | Description | 
|---|---|
| Error | The resource management error additional info. | 
| Error | The error detail. | 
| Error | Error response | 
| Sync | Sync direction of the sync member. | 
| Sync | An Azure SQL Database sync member. | 
| Sync | Database type of the sync member. | 
| Sync | Sync state of the sync member. | 
ErrorAdditionalInfo  
			
			The resource management error additional info.
| Name | Type | Description | 
|---|---|---|
| info | object | The additional info. | 
| type | string | The additional info type. | 
ErrorDetail 
			
			The error detail.
| Name | Type | Description | 
|---|---|---|
| additionalInfo | The error additional info. | |
| code | string | The error code. | 
| details | The error details. | |
| message | string | The error message. | 
| target | string | The error target. | 
ErrorResponse 
			
			Error response
| Name | Type | Description | 
|---|---|---|
| error | The error object. | 
SyncDirection 
			
			Sync direction of the sync member.
| Value | Description | 
|---|---|
| Bidirectional | |
| OneWayMemberToHub | |
| OneWayHubToMember | 
SyncMember 
			
			An Azure SQL Database sync member.
| Name | Type | Description | 
|---|---|---|
| id | string | Resource ID. | 
| name | string | Resource name. | 
| properties.databaseName | string | Database name of the member database in the sync member. | 
| properties.databaseType | 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 | 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 | 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. | 
| type | string | Resource type. | 
SyncMemberDbType  
			
			Database type of the sync member.
| Value | Description | 
|---|---|
| AzureSqlDatabase | |
| SqlServerDatabase | 
SyncMemberState  
			
			Sync state of the sync member.
| Value | Description | 
|---|---|
| SyncInProgress | |
| SyncSucceeded | |
| SyncFailed | |
| DisabledTombstoneCleanup | |
| DisabledBackupRestore | |
| SyncSucceededWithWarnings | |
| SyncCancelling | |
| SyncCancelled | |
| UnProvisioned | |
| Provisioning | |
| Provisioned | |
| ProvisionFailed | |
| DeProvisioning | |
| DeProvisioned | |
| DeProvisionFailed | |
| Reprovisioning | |
| ReprovisionFailed | |
| UnReprovisioned |