Sync Groups - Create Or Update

Служба:: SQL Database

Версия API:: 2023-08-01

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

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

Параметры URI

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

Текст запроса

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

Ответы

Имя	Тип	Описание
200 OK	SyncGroup	Успешно обновлена группа синхронизации.
201 Created	SyncGroup	Успешно создана группа синхронизации.
202 Accepted		Выполняется создание или обновление группы синхронизации. Заголовки Location: string
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 InvalidSyncGroupCreateOrUpdateRequest — текст запроса на создание или обновление группы синхронизации пуст. 400 InvalidSyncMemberCreateOrUpdateRequest — текст запроса на создание или обновление элемента синхронизации пуст. 400 InvalidSyncAgentCreateOrUpdateRequest . Текст запроса агента создания или обновления синхронизации пуст. 400 InvalidDatabaseResourceId — недопустимый идентификатор ресурса базы данных. 400 InvalidSyncGroupName — недопустимое имя группы синхронизации. Это поле может содержать буквы, цифры, дефисы и символы подчеркивания. 400 InvalidSyncMemberName — недопустимое имя члена синхронизации. Это поле может содержать буквы, цифры, дефисы и символы подчеркивания. 400 MissingSyncMemberName — отсутствует имя члена синхронизации 400 InvalidSyncGroupInterval — интервал синхронизации должен быть больше или равен 5 секундам. 400 НесоответствиеSubscriptionWithUrl — указанная подписка не соответствует подписке в 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 CannotCreateSyncGroupDueToQuotaExceed. Не удается создать группу синхронизации из-за превышения квоты. 400 SyncOperation_DuplicateSyncGroupDrop — группа синхронизации уже удаляется. 400 SyncOperation_WrongSyncDatabase. Указанная база данных синхронизации не соответствует существующей. 400 SyncOperation_UpdateSyncGroupWhenDropping. Не удается обновить группу синхронизации, так как она в настоящее время удаляется. 400 SyncOperation_DwInSyncGroup . Не удается использовать выпуск datawarehouse в синхронизации данных. 400 SyncOperation_MasterDbInSyncGroup. Не удается использовать логический главный в синхронизации данных. 400 SyncOperation_UnsupportedDataTypeColumnInSchema. Невозможно добавить столбец в схему, так как тип данных столбца не поддерживается. 400 SyncOperation_InvalidCredential . Учетные данные базы данных недопустимы. 400 InvalidSyncMetadataDatabase— недопустимая база данных метаданных синхронизации. 400 SyncOperation_InvalidSyncInterval . Не удается создать или обновить группу синхронизации, так как интервал синхронизации недопустим. 404 ResourceNotFound — запрошенный ресурс не найден. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера. 404 SyncOperation_HubServerNotFound — логический сервер концентратора не существует. 404 SyncOperation_InvalidHubDatabase — база данных концентратора недопустима. 404 OperationIdNotFound — операция с идентификатором не существует. 409 SyncOperation_DuplicateSyncGroupName . Не удается создать группу синхронизации, так как группа синхронизации с тем же именем уже существует. 409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено. 409 OperationCancelled — операция отменена пользователем. 409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе. 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Примеры

Create a sync group

Update a sync group

Create a sync group

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

HTTP

PUT 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?api-version=2023-08-01

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}

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

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

{
  "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-8475"
  },
  "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"
}

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

{
  "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-8475"
  },
  "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"
}

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

Update a sync group

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

HTTP

PUT 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?api-version=2023-08-01

{
  "properties": {
    "interval": -1,
    "conflictResolutionPolicy": "HubWin",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "hubDatabaseUserName": "hubUser",
    "usePrivateLinkConnection": true
  }
}

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

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

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

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

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

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

Определения

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

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

Сведения об ошибке.

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

ErrorResponse

Объект

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

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

Sku

Объект

SKU ресурса ARM.

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

SyncConflictResolutionPolicy

Перечисление

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

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

SyncGroup

Объект

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

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

SyncGroupSchema

Объект

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

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

SyncGroupSchemaTable

Объект

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

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

SyncGroupSchemaTableColumn

Объект

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

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

SyncGroupState

Перечисление

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

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

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

Sync Groups - Create Or Update

Параметры URI

Текст запроса

Ответы

Примеры

Create a sync group

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

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

Update a sync group

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

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

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState