Sync Groups - List Hub Schemas

Service:

SQL Database

API Version:

2021-11-01

Gets a collection of hub database schemas.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?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.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	SyncFullSchemaPropertiesListResult	Successfully get a sync group hub database schema.
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 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition. 400 CannotCreateSyncGroupDueToQuotaExceeded - Cannot create sync group due to quota exceeded. 400 SyncOperation_DuplicateSyncGroupDrop - The sync group is already being dropped. 400 SyncOperation_WrongSyncDatabase - The sync database specified does not match the existing one. 400 SyncOperation_UpdateSyncGroupWhenDropping - Cannot update the sync group because it is currently being dropped. 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. 400 SyncOperation_InvalidSyncInterval - Cannot create or update sync group because the sync interval 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_DuplicateSyncGroupName - Cannot create sync group because the sync group with the same name already exists.

Examples

Get a hub database 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/hubSchemas?api-version=2021-11-01

Java

/**
 * Samples for SyncGroups ListHubSchemas.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupGetHubSchema.json
     */
    /**
     * Sample code: Get a hub database schema.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAHubDatabaseSchema(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().listHubSchemas("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", 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

{
  "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
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.

SyncFullSchemaProperties

Properties of the database full schema.

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

SyncFullSchemaPropertiesListResult

A list of sync schema properties.

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

SyncFullSchemaTable

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

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.