Sync Groups - List Hub Schemas

Служба:: SQL Database

Версия API:: 2025-01-01

Возвращает коллекцию схем базы данных концентратора.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/hubSchemas?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
syncGroupName	path	True	string	Имя группы синхронизации.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	SyncFullSchemaPropertiesListResult	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get a hub database schema.

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=2025-01-01

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/SQL/stable/2025-01-01/examples/SyncGroupGetHubSchema.json
// this example is just showing the usage of "SyncGroups_ListHubSchemas" 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 SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// invoke the operation and iterate over the result
await foreach (SyncFullSchemaProperties item in syncGroup.GetHubSchemasAsync())
{
    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

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
SyncFullSchemaProperties	Свойства полной схемы базы данных.
SyncFullSchemaPropertiesListResult	Список свойств схемы синхронизации.
SyncFullSchemaTable	Свойства таблицы в полной схеме базы данных.
SyncFullSchemaTableColumn	Свойства столбца в таблице полной схемы базы данных.

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SyncFullSchemaProperties

Объект

Свойства полной схемы базы данных.

Имя	Тип	Описание
lastUpdateTime	string (date-time)	Время последнего обновления схемы базы данных.
tables	SyncFullSchemaTable[]	Список таблиц в полной схеме базы данных.

SyncFullSchemaPropertiesListResult

Объект

Список свойств схемы синхронизации.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	SyncFullSchemaProperties[]	Элементы SyncFullSchemaProperties на этой странице

SyncFullSchemaTable

Объект

Свойства таблицы в полной схеме базы данных.

Имя	Тип	Описание
columns	SyncFullSchemaTableColumn[]	Список столбцов в таблице полной схемы базы данных.
errorId	string	Идентификатор ошибки таблицы.
hasError	boolean	Если в таблице возникает ошибка.
name	string	Название таблицы.
quotedName	string	Кавычекное имя таблицы.

SyncFullSchemaTableColumn

Объект

Свойства столбца в таблице полной схемы базы данных.

Имя	Тип	Описание
dataSize	string	Размер данных столбца.
dataType	string	Тип данных столбца.
errorId	string	Идентификатор ошибки столбца.
hasError	boolean	Если в таблице возникает ошибка.
isPrimaryKey	boolean	Если это первичный ключ таблицы.
name	string	Имя столбца.
quotedName	string	Кавычекное имя столбца.