Sync Members - Create Or Update

Reference

Service:: SQL Database

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

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database on which the sync group is hosted.
resourceGroupName	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.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
syncGroupName	path	True	string	The name of the sync group on which the sync member is hosted.
syncMemberName	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	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	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	Successfully updated the sync member.
201 Created	SyncMember	Successfully created the sync member.
202 Accepted		Creating or updating the sync member is in progress.
Other Status Codes		* Error Responses: * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty. 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty. 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty. 400 InvalidDatabaseResourceId - Invalid database resource identifier. 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url. 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier. 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url. 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url. 400 InvalidParameterValue - An invalid value was given to a parameter. 400 MissingServerName - The Server name is missing 400 MissingDatabaseName - The Database name is missing 400 MissingSyncGroupName - The Sync Group name is missing 400 MissingConflictResolutionPolicy - The Conflict Resolution Policy is missing 400 MissingSyncAgentName - The Sync Agent name is missing 400 SyncOperation_GenericFailure - Failed to perform data sync operation. 400 InvalidSyncGroup - Sync group is invalid. 400 InvalidSyncMember - Sync member is invalid. 400 InvalidSyncAgent - Sync agent is invalid. 400 CannotCreateSyncMemberDueToQuotaExceeded - Cannot create sync member due to quota exceeded. 400 SyncOperation_DuplicateSyncMemberDrop - The sync member is already being dropped. 400 SyncOperation_WrongSyncDatabase - The sync database specified does not match the existing one. 400 SyncOperation_DwInSyncGroup - Cannot use datawarehouse edition in data sync. 400 SyncOperation_MasterDbInSyncGroup - Cannot use logical master in data sync. 400 SyncOperation_InvalidCredential - Credential of database is invalid. 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid. 404 ResourceNotFound - The requested resource was not found. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 SyncOperation_HubServerNotFound - Hub logical server does not exist. 404 SyncOperation_InvalidHubDatabase - Hub database is invalid. 404 OperationIdNotFound - The operation with Id does not exist. 409 SyncOperation_DuplicateSyncMemberName - Cannot create sync member because the sync member with the same name already exists. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

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

Definitions

Name	Description
SyncDirection	Sync direction of the sync member.
SyncMember	An Azure SQL Database sync member.
SyncMemberDbType	Database type of the sync member.
SyncMemberState	Sync state of the sync member.

SyncDirection

Sync direction of the sync member.

Name	Type	Description
Bidirectional	string
OneWayHubToMember	string
OneWayMemberToHub	string

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	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	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.
type	string	Resource type.

SyncMemberDbType

Database type of the sync member.

Name	Type	Description
AzureSqlDatabase	string
SqlServerDatabase	string

SyncMemberState

Sync state of the sync member.

Name	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

URI Parameters

Request Body

Responses

Examples

Create a new sync member

Sample Request

Sample Response

Update a sync member

Sample Request

Sample Response

Definitions

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

Additional resources