Sync Members - List Member Schemas

Service:

SQL Database

API Version:

2023-08-01

Gets a sync member database schema.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}/schemas?api-version=2023-08-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	SyncFullSchemaPropertiesListResult	Successfully get a sync member schema.
Other Status Codes	ErrorResponse	*** 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 InvalidSyncGroupName - The Sync Group name is invalid. This field can contain letters, numbers, dashes and underscores. 400 InvalidSyncMemberName - The Sync Member name is invalid. This field can contain letters, numbers, dashes and underscores. 400 MissingSyncMemberName - The Sync Member name is missing 400 InvalidSyncGroupInterval - Sync Interval should be greater than or equal to 5 seconds. 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_UnsupportedDataTypeColumnInSchema - Cannot add column to schema because the data type of the column is unsupported. 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. 409 SyncOperation_DuplicateSyncMemberName - Cannot create sync member because the sync member with the same name already exists.

Examples

Get a sync member schema

Sample request

HTTP

GET 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/schemas?api-version=2023-08-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncMemberGetSchema.json
// this example is just showing the usage of "SyncMembers_ListMemberSchemas" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SyncMemberResource created on azure
// for more information of creating SyncMemberResource, please refer to the document of SyncMemberResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
string syncMemberName = "syncgroupcrud-4879";
ResourceIdentifier syncMemberResourceId = SyncMemberResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName, syncMemberName);
SyncMemberResource syncMember = client.GetSyncMemberResource(syncMemberResourceId);

// invoke the operation and iterate over the result
await foreach (SyncFullSchemaProperties item in syncMember.GetMemberSchemasAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "tables": [
        {
          "columns": [
            {
              "dataSize": "4",
              "dataType": "int",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "intField",
              "quotedName": "[intField]"
            },
            {
              "dataSize": "100",
              "dataType": "nvarchar",
              "hasError": false,
              "isPrimaryKey": false,
              "name": "charField",
              "quotedName": "[charField]"
            }
          ],
          "errorId": "Schema_TableHasNoPrimaryKey",
          "hasError": true,
          "name": "dbo.myTable",
          "quotedName": "[dbo].[myTable]"
        }
      ],
      "lastUpdateTime": "2017-05-30T07:16:08.21Z"
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SyncFullSchemaProperties	Properties of the database full schema.
SyncFullSchemaPropertiesListResult	A list of sync schema properties.
SyncFullSchemaTable	Properties of the table in the database full schema.
SyncFullSchemaTableColumn	Properties of the column in the table of database full schema.

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.

SyncFullSchemaProperties

Object

Properties of the database full schema.

Name	Type	Description
lastUpdateTime	string (date-time)	Last update time of the database schema.
tables	SyncFullSchemaTable[]	List of tables in the database full schema.

SyncFullSchemaPropertiesListResult

Object

A list of sync schema properties.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	SyncFullSchemaProperties[]	Array of results.

SyncFullSchemaTable

Object

Properties of the table in the database full schema.

Name	Type	Description
columns	SyncFullSchemaTableColumn[]	List of columns in the table of database full schema.
errorId	string	Error id of the table.
hasError	boolean	If there is error in the table.
name	string	Name of the table.
quotedName	string	Quoted name of the table.

SyncFullSchemaTableColumn

Object

Properties of the column in the table of database full schema.

Name	Type	Description
dataSize	string	Data size of the column.
dataType	string	Data type of the column.
errorId	string	Error id of the column.
hasError	boolean	If there is error in the table.
isPrimaryKey	boolean	If it is the primary key of the table.
name	string	Name of the column.
quotedName	string	Quoted name of the column.