Sync Members - Create Or Update
Создает или обновляет элемент синхронизации.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}/syncMembers/{syncMemberName}?api-version=2023-08-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
database
|
path | True |
string |
Имя базы данных, в которой размещена группа синхронизации. |
|
resource
|
path | True |
string |
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. |
|
server
|
path | True |
string |
Имя сервера. |
|
subscription
|
path | True |
string |
Идентификатор подписки, идентифицирующий подписку Azure. |
|
sync
|
path | True |
string |
Имя группы синхронизации, в которой размещен член синхронизации. |
|
sync
|
path | True |
string |
Имя члена синхронизации. |
|
api-version
|
query | True |
string |
Версия API, используемая для запроса. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| properties.databaseName |
string |
Имя базы данных-члена в элементе синхронизации. |
| properties.databaseType |
Тип базы данных члена синхронизации. |
|
| properties.password |
string |
Пароль базы данных-члена в элементе синхронизации. |
| properties.serverName |
string |
Имя сервера базы данных-члена в элементе синхронизации |
| properties.sqlServerDatabaseId |
string (uuid) |
Идентификатор базы данных SQL Server элемента синхронизации. |
| properties.syncAgentId |
string |
Идентификатор ресурса ARM агента синхронизации в элементе синхронизации. |
| properties.syncDirection |
Направление синхронизации элемента синхронизации. |
|
| properties.syncMemberAzureDatabaseResourceId |
string |
Идентификатор ресурса ARM логической базы данных-члена синхронизации для членов синхронизации в Azure. |
| properties.usePrivateLinkConnection |
boolean |
Следует ли использовать подключение с приватным каналом. |
| properties.userName |
string |
Имя пользователя базы данных-члена в элементе синхронизации. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешно обновлен элемент синхронизации. |
|
| 201 Created |
Успешно создан элемент синхронизации. |
|
| 202 Accepted |
Выполняется создание или обновление элемента синхронизации. Заголовки Location: string |
|
| Other Status Codes |
Ответы на ошибки: ***
|
Примеры
| Create a new sync member |
| Update a sync member |
Create a new sync member
Образец запроса
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/syncMembers/syncmembercrud-4879?api-version=2023-08-01
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"usePrivateLinkConnection": true,
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
}
}
Пример ответа
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"syncState": "UnProvisioned",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
"name": "syncmembercrud-4879",
"type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"syncState": "UnProvisioned",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
"name": "syncmembercrud-4879",
"type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}
Update a sync member
Образец запроса
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/syncMembers/syncmembercrud-4879?api-version=2023-08-01
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"usePrivateLinkConnection": true,
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
}
}
Пример ответа
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"syncState": "UnProvisioned",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
"name": "syncmembercrud-4879",
"type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}
{
"properties": {
"databaseType": "AzureSqlDatabase",
"serverName": "syncgroupcrud-3379.database.windows.net",
"databaseName": "syncgroupcrud-7421",
"userName": "myUser",
"syncDirection": "Bidirectional",
"syncState": "UnProvisioned",
"usePrivateLinkConnection": true,
"privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
"syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"
},
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
"name": "syncmembercrud-4879",
"type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers"
}
Определения
| Имя | Описание |
|---|---|
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Ответ на ошибку |
|
Sync |
Направление синхронизации элемента синхронизации. |
|
Sync |
Член синхронизации базы данных SQL Azure. |
|
Sync |
Тип базы данных члена синхронизации. |
|
Sync |
Состояние синхронизации члена синхронизации. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
SyncDirection
Направление синхронизации элемента синхронизации.
| Значение | Описание |
|---|---|
| Bidirectional | |
| OneWayMemberToHub | |
| OneWayHubToMember |
SyncMember
Член синхронизации базы данных SQL Azure.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Идентификатор ресурса. |
| name |
string |
Имя ресурса. |
| properties.databaseName |
string |
Имя базы данных-члена в элементе синхронизации. |
| properties.databaseType |
Тип базы данных члена синхронизации. |
|
| properties.password |
string |
Пароль базы данных-члена в элементе синхронизации. |
| properties.privateEndpointName |
string |
Имя частной конечной точки члена синхронизации, если включено подключение приватного канала для членов синхронизации в Azure. |
| properties.serverName |
string |
Имя сервера базы данных-члена в элементе синхронизации |
| properties.sqlServerDatabaseId |
string (uuid) |
Идентификатор базы данных SQL Server элемента синхронизации. |
| properties.syncAgentId |
string |
Идентификатор ресурса ARM агента синхронизации в элементе синхронизации. |
| properties.syncDirection |
Направление синхронизации элемента синхронизации. |
|
| properties.syncMemberAzureDatabaseResourceId |
string |
Идентификатор ресурса ARM логической базы данных-члена синхронизации для членов синхронизации в Azure. |
| properties.syncState |
Состояние синхронизации члена синхронизации. |
|
| properties.usePrivateLinkConnection |
boolean |
Следует ли использовать подключение с приватным каналом. |
| properties.userName |
string |
Имя пользователя базы данных-члена в элементе синхронизации. |
| type |
string |
Тип ресурса. |
SyncMemberDbType
Тип базы данных члена синхронизации.
| Значение | Описание |
|---|---|
| AzureSqlDatabase | |
| SqlServerDatabase |
SyncMemberState
Состояние синхронизации члена синхронизации.
| Значение | Описание |
|---|---|
| SyncInProgress | |
| SyncSucceeded | |
| SyncFailed | |
| DisabledTombstoneCleanup | |
| DisabledBackupRestore | |
| SyncSucceededWithWarnings | |
| SyncCancelling | |
| SyncCancelled | |
| UnProvisioned | |
| Provisioning | |
| Provisioned | |
| ProvisionFailed | |
| DeProvisioning | |
| DeProvisioned | |
| DeProvisionFailed | |
| Reprovisioning | |
| ReprovisionFailed | |
| UnReprovisioned |