Sync Groups - List By Database

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Списки группы синхронизации в центральной базе данных.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных, в которой размещена группа синхронизации.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	SyncGroupListResult	Список групп синхронизации успешно получен.
Other Status Codes		Ответы на ошибки: *** 400 InvalidSyncGroupCreateOrUpdateRequest — текст запроса на создание или обновление группы синхронизации пуст. 400 InvalidSyncMemberCreateOrUpdateRequest — текст запроса на создание или обновление элемента синхронизации пуст. 400 InvalidSyncAgentCreateOrUpdateRequest — текст запроса на создание или обновление агента синхронизации пуст. 400 InvalidDatabaseResourceId — недопустимый идентификатор ресурса базы данных. 400 MismatchingSubscriptionWithUrl — указанная подписка не соответствует подписке в URL-адресе. 400 InvalidSyncAgentResourceId — недопустимый идентификатор ресурса агента синхронизации. 400 MismatchingResourceGroupNameWithUrl — предоставленное имя группы ресурсов не совпадает с именем в URL-адресе. 400 MismatchingServerNameWithUrl — предоставленное имя сервера не совпадает с именем в URL-адресе. 400 InvalidParameterValue — параметру присвоено недопустимое значение. 400 MissingServerName — отсутствует имя сервера. 400 MissingDatabaseName — отсутствует имя базы данных. 400 MissingSyncGroupName — отсутствует имя группы синхронизации 400 MissingConflictResolutionPolicy — отсутствует политика разрешения конфликтов 400 MissingSyncAgentName — отсутствует имя агента синхронизации. 400 SyncOperation_GenericFailure — не удалось выполнить операцию синхронизации данных. 400 InvalidSyncGroup — недопустимая группа синхронизации. 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 CannotCreateSyncGroupDueToQuotaExceededed — не удается создать группу синхронизации из-за превышения квоты. 400 SyncOperation_DuplicateSyncGroupDrop — группа синхронизации уже удаляется. 400 SyncOperation_WrongSyncDatabase — указанная база данных синхронизации не соответствует существующей. 400 SyncOperation_UpdateSyncGroupWhenDropping — не удается обновить группу синхронизации, так как она сейчас удаляется. 400 SyncOperation_DwInSyncGroup — не удается использовать выпуск datawarehouse в синхронизации данных. 400 SyncOperation_MasterDbInSyncGroup — не удается использовать логические master при синхронизации данных. 400 SyncOperation_InvalidCredential — недопустимые учетные данные базы данных. 400 InvalidSyncMetadataDatabase — база данных метаданных синхронизации недопустима. 400 SyncOperation_InvalidSyncInterval — не удается создать или обновить группу синхронизации, так как интервал синхронизации недопустим. 404 ResourceNotFound — запрошенный ресурс не найден. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера. 404 SyncOperation_HubServerNotFound — логический сервер концентратора не существует. 404 SyncOperation_InvalidHubDatabase — недопустимая база данных концентратора. 409 SyncOperation_DuplicateSyncGroupName — не удается создать группу синхронизации, так как группа синхронизации с тем же именем уже существует.

Имя

Тип

Описание

200 OK

SyncGroupListResult

Список групп синхронизации успешно получен.

Other Status Codes

Ответы на ошибки: ***

400 InvalidSyncGroupCreateOrUpdateRequest — текст запроса на создание или обновление группы синхронизации пуст.
400 InvalidSyncMemberCreateOrUpdateRequest — текст запроса на создание или обновление элемента синхронизации пуст.
400 InvalidSyncAgentCreateOrUpdateRequest — текст запроса на создание или обновление агента синхронизации пуст.
400 InvalidDatabaseResourceId — недопустимый идентификатор ресурса базы данных.
400 MismatchingSubscriptionWithUrl — указанная подписка не соответствует подписке в URL-адресе.
400 InvalidSyncAgentResourceId — недопустимый идентификатор ресурса агента синхронизации.
400 MismatchingResourceGroupNameWithUrl — предоставленное имя группы ресурсов не совпадает с именем в URL-адресе.
400 MismatchingServerNameWithUrl — предоставленное имя сервера не совпадает с именем в URL-адресе.
400 InvalidParameterValue — параметру присвоено недопустимое значение.
400 MissingServerName — отсутствует имя сервера.
400 MissingDatabaseName — отсутствует имя базы данных.
400 MissingSyncGroupName — отсутствует имя группы синхронизации
400 MissingConflictResolutionPolicy — отсутствует политика разрешения конфликтов
400 MissingSyncAgentName — отсутствует имя агента синхронизации.
400 SyncOperation_GenericFailure — не удалось выполнить операцию синхронизации данных.
400 InvalidSyncGroup — недопустимая группа синхронизации.
400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.
400 CannotCreateSyncGroupDueToQuotaExceededed — не удается создать группу синхронизации из-за превышения квоты.
400 SyncOperation_DuplicateSyncGroupDrop — группа синхронизации уже удаляется.
400 SyncOperation_WrongSyncDatabase — указанная база данных синхронизации не соответствует существующей.
400 SyncOperation_UpdateSyncGroupWhenDropping — не удается обновить группу синхронизации, так как она сейчас удаляется.
400 SyncOperation_DwInSyncGroup — не удается использовать выпуск datawarehouse в синхронизации данных.
400 SyncOperation_MasterDbInSyncGroup — не удается использовать логические master при синхронизации данных.
400 SyncOperation_InvalidCredential — недопустимые учетные данные базы данных.
400 InvalidSyncMetadataDatabase — база данных метаданных синхронизации недопустима.
400 SyncOperation_InvalidSyncInterval — не удается создать или обновить группу синхронизации, так как интервал синхронизации недопустим.
404 ResourceNotFound — запрошенный ресурс не найден.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера.
404 SyncOperation_HubServerNotFound — логический сервер концентратора не существует.
404 SyncOperation_InvalidHubDatabase — недопустимая база данных концентратора.
409 SyncOperation_DuplicateSyncGroupName — не удается создать группу синхронизации, так как группа синхронизации с тем же именем уже существует.

Примеры

List sync groups under a given database

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups?api-version=2021-11-01


/**
 * Samples for SyncGroups ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncGroupListByDatabase.json
     */
    /**
     * Sample code: List sync groups under a given database.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listSyncGroupsUnderAGivenDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncGroups().listByDatabase("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", 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

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

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

{
  "value": [
    {
      "properties": {
        "interval": -1,
        "lastSyncTime": "0001-01-01T08:00:00Z",
        "conflictResolutionPolicy": "HubWin",
        "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        "hubDatabaseUserName": "hubUser",
        "syncState": "NotReady",
        "usePrivateLinkConnection": true,
        "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
      "name": "syncgroupcrud-3187",
      "type": "Microsoft.Sql/servers/databases/syncGroups"
    },
    {
      "properties": {
        "interval": -1,
        "lastSyncTime": "0001-01-01T08:00:00Z",
        "conflictResolutionPolicy": "HubWin",
        "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
        "hubDatabaseUserName": "hubUser",
        "syncState": "NotReady",
        "usePrivateLinkConnection": true,
        "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-5374"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374",
      "name": "syncgroupcrud-5374",
      "type": "Microsoft.Sql/servers/databases/syncGroups"
    }
  ]
}

Определения

Имя	Описание
Sku	SKU ресурса ARM.
SyncConflictResolutionPolicy	Политика разрешения конфликтов группы синхронизации.
SyncGroup	Группа синхронизации базы данных Azure SQL.
SyncGroupListResult	Список групп синхронизации.
SyncGroupSchema	Свойства схемы группы синхронизации.
SyncGroupSchemaTable	Свойства таблицы в схеме группы синхронизации.
SyncGroupSchemaTableColumn	Свойства столбца в таблице группы синхронизации.
SyncGroupState	Состояние синхронизации группы синхронизации.

Sku

Object

SKU ресурса ARM.

Имя	Тип	Описание
capacity	integer	Емкость конкретного номера SKU.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU, как правило, буква + числовой код, например P3.
size	string	Размер конкретного номера SKU
tier	string	Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

SyncConflictResolutionPolicy

Enumeration

Политика разрешения конфликтов группы синхронизации.

Значение	Описание
HubWin
MemberWin

SyncGroup

Object

Группа синхронизации базы данных Azure SQL.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.conflictLoggingRetentionInDays	integer	Период хранения ведения журнала конфликтов.
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	Политика разрешения конфликтов группы синхронизации.
properties.enableConflictLogging	boolean	Если ведение журнала конфликтов включено.
properties.hubDatabasePassword	string	Пароль для учетных данных базы данных центра группы синхронизации.
properties.hubDatabaseUserName	string	Имя пользователя для учетных данных базы данных концентратора группы синхронизации.
properties.interval	integer	Интервал синхронизации группы синхронизации.
properties.lastSyncTime	string	Время последней синхронизации группы синхронизации.
properties.privateEndpointName	string	Имя частной конечной точки группы синхронизации, если используется подключение с приватным каналом, включено.
properties.schema	SyncGroupSchema	Схема синхронизации группы синхронизации.
properties.syncDatabaseId	string	Идентификатор ресурса ARM базы данных синхронизации в группе синхронизации.
properties.syncState	SyncGroupState	Состояние синхронизации группы синхронизации.
properties.usePrivateLinkConnection	boolean	Если использовать приватный канал, подключение включено.
sku	Sku	Имя и емкость номера SKU.
type	string	Тип ресурса.

SyncGroupListResult

Object

Список групп синхронизации.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	SyncGroup[]	Массив результатов.

SyncGroupSchema

Object

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

Имя	Тип	Описание
masterSyncMemberName	string	Имя master элемента синхронизации, из которого находится схема.
tables	SyncGroupSchemaTable[]	Список таблиц в схеме группы синхронизации.

SyncGroupSchemaTable

Object

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

Имя	Тип	Описание
columns	SyncGroupSchemaTableColumn[]	Список столбцов в схеме группы синхронизации.
quotedName	string	Имя таблицы схемы группы синхронизации в кавычках.

SyncGroupSchemaTableColumn

Object

Свойства столбца в таблице группы синхронизации.

Имя	Тип	Описание
dataSize	string	Размер данных столбца.
dataType	string	Тип данных столбца.
quotedName	string	Имя столбца таблицы группы синхронизации в кавычках.

SyncGroupState

Enumeration

Состояние синхронизации группы синхронизации.

Значение	Описание
Error
Good
NotReady
Progressing
Warning

Поделиться через

Sync Groups - List By Database

Параметры URI

Ответы

Примеры

List sync groups under a given database

Образец запроса

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

Определения

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupListResult

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

Дополнительные ресурсы