Sync Members - Refresh Member Schema

Service:

SQL Database

API Version:

2021-11-01

Refreshes a sync member database schema.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/refreshSchema?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.

Responses

Name	Type	Description
200 OK		Successfully refreshed a sync member schema.
202 Accepted		The sync member schema refresh operation is on going.
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 OperationIdNotFound - The operation with Id does not exist. 404 OperationIdNotFound - The operation with Id does not exist. 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. 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. 409 SyncOperation_DuplicateSyncMemberName - Cannot create sync member because the sync member with the same name already exists. 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

Refresh a sync member database schema

Sample request

HTTP

POST 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/syncgroupcrud-4879/refreshSchema?api-version=2021-11-01

Java

/**
 * Samples for SyncMembers RefreshMemberSchema.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncMemberRefreshSchema.json
     */
    /**
     * Sample code: Refresh a sync member database schema.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void refreshASyncMemberDatabaseSchema(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncMembers().refreshMemberSchema("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", "syncgroupcrud-4879",
            com.azure.core.util.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

Status code:

202