Sync Agents - List Linked Databases

Служба:

SQL Database

Версия API:

2021-11-01

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	SyncAgentLinkedDatabaseListResult	Базы данных SQL Server, связанные с агентом синхронизации, успешно получены.
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 SyncOperation_WrongSyncDatabase — указанная база данных синхронизации не соответствует существующей. 400 SyncOperation_DwInSyncGroup — не удается использовать выпуск datawarehouse в синхронизации данных. 400 SyncOperation_MasterDbInSyncGroup — не удается использовать логические master при синхронизации данных. 400 CannotDeleteInUseSyncAgent — не удается удалить агент синхронизации, так как он используется членом синхронизации. 400 InvalidSyncAgent — агент синхронизации недопустим. 400 InvalidSyncMetadataDatabase — база данных метаданных синхронизации недопустима. 404 ResourceNotFound — запрошенный ресурс не найден. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — пользователь указал имя базы данных, которое не существует на этом экземпляре сервера. 409 SyncOperation_AgentAlreadyExists — агент синхронизации с тем же именем уже существует. 409 SyncOperation_AgentIdAlreadyExists — агент синхронизации с тем же идентификатором уже существует.

Примеры

Get sync agent linked databases

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

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases?api-version=2021-11-01

Java

/**
 * Samples for SyncAgents ListLinkedDatabases.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGetLinkedDatabases.json
     */
    /**
     * Sample code: Get sync agent linked databases.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSyncAgentLinkedDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().listLinkedDatabases("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187", 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": {
        "databaseType": "SqlServerDatabase",
        "databaseId": "55555555-6666-7777-8888-999999999999",
        "description": "",
        "serverName": "DummySqlServer",
        "databaseName": "DummySqlServerDb",
        "userName": "DummyUser"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases/55555555-6666-7777-8888-999999999999"
    }
  ]
}

Определения

Имя	Описание
SyncAgentLinkedDatabase	Связанная база данных агента синхронизации базы данных Azure SQL.
SyncAgentLinkedDatabaseListResult	Список связанных баз данных агента синхронизации.
SyncMemberDbType	Тип связанной базы данных агента синхронизации.

SyncAgentLinkedDatabase

Связанная база данных агента синхронизации базы данных Azure SQL.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.databaseId	string	Идентификатор связанной базы данных агента синхронизации.
properties.databaseName	string	Имя базы данных связанной базы данных агента синхронизации.
properties.databaseType	SyncMemberDbType	Тип связанной базы данных агента синхронизации.
properties.description	string	Описание связанной базы данных агента синхронизации.
properties.serverName	string	Имя сервера связанной базы данных агента синхронизации.
properties.userName	string	Имя пользователя связанной базы данных агента синхронизации.
type	string	Тип ресурса.

SyncAgentLinkedDatabaseListResult

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

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

SyncMemberDbType

Тип связанной базы данных агента синхронизации.

Имя	Тип	Описание
AzureSqlDatabase	string
SqlServerDatabase	string