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


Sync Groups - Create Or Update

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?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.

syncGroupName
path True

string

Имя группы синхронизации.

api-version
query True

string

Версия API для использования в запросе.

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

Имя Тип Описание
properties.conflictLoggingRetentionInDays

integer

Период хранения ведения журнала конфликтов.

properties.conflictResolutionPolicy

SyncConflictResolutionPolicy

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

properties.enableConflictLogging

boolean

Если ведение журнала конфликтов включено.

properties.hubDatabasePassword

string

Пароль для учетных данных базы данных центра группы синхронизации.

properties.hubDatabaseUserName

string

Имя пользователя для учетных данных базы данных центра группы синхронизации.

properties.interval

integer

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

properties.schema

SyncGroupSchema

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

properties.syncDatabaseId

string

Идентификатор ресурса ARM для базы данных синхронизации в группе синхронизации.

properties.usePrivateLinkConnection

boolean

Если использовать приватный канал, подключение включено.

sku

Sku

Имя и емкость номера SKU.

Ответы

Имя Тип Описание
200 OK

SyncGroup

Группа синхронизации успешно обновлена.

201 Created

SyncGroup

Группа синхронизации успешно создана.

202 Accepted

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

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 CannotCreateSyncGroupDueToQuotaExceeded — не удается создать группу синхронизации из-за превышения квоты.

  • 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 — недопустимая база данных концентратора.

  • 404 OperationIdNotFound — операция с идентификатором не существует.

  • 409 SyncOperation_DuplicateSyncGroupName — не удается создать группу синхронизации, так как группа синхронизации с тем же именем уже существует.

  • 409 OperationCancelled — операция была отменена пользователем.

  • 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы сверх максимального количества запросов, которые могут быть обработаны доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы, превышающие максимальное количество запросов, которые могут быть обработаны доступными ресурсами.

  • 500 OperationTimedOut — время ожидания операции истекло и автоматически откатывается. Повторите операцию.

  • 503 TooManyRequests — запросы сверх максимального числа запросов, которые могут быть обработаны доступными ресурсами.

Примеры

Create a sync group
Update a sync group

Create a sync group

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

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=2021-11-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
  }
}

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

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

Update a sync group

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

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=2021-11-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
  }
}

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

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

Определения

Имя Описание
Sku

SKU ресурса ARM.

SyncConflictResolutionPolicy

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

SyncGroup

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

SyncGroupSchema

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

SyncGroupSchemaTable

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

SyncGroupSchemaTableColumn

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

SyncGroupState

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

Sku

SKU ресурса ARM.

Имя Тип Описание
capacity

integer

Емкость конкретного номера SKU.

family

string

Если служба имеет разные поколения оборудования для одного номера SKU, то это можно записать здесь.

name

string

Имя номера SKU, как правило, буква + номер, например P3.

size

string

Размер конкретного номера SKU

tier

string

Уровень или выпуск конкретного номера SKU, например "Базовый", "Премиум".

SyncConflictResolutionPolicy

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

Имя Тип Описание
HubWin

string

MemberWin

string

SyncGroup

Группа синхронизации базы данных 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

Тип ресурса.

SyncGroupSchema

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

Имя Тип Описание
masterSyncMemberName

string

Имя master элемента синхронизации, из которого находится схема.

tables

SyncGroupSchemaTable[]

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

SyncGroupSchemaTable

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

Имя Тип Описание
columns

SyncGroupSchemaTableColumn[]

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

quotedName

string

Имя таблицы схемы группы синхронизации в кавычках.

SyncGroupSchemaTableColumn

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

Имя Тип Описание
dataSize

string

Размер данных столбца.

dataType

string

Тип данных столбца.

quotedName

string

Имя столбца таблицы группы синхронизации в кавычках.

SyncGroupState

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

Имя Тип Описание
Error

string

Good

string

NotReady

string

Progressing

string

Warning

string