Sync Agents - Generate Key

Служба:

SQL Database

Версия API:

2021-11-01

Создает ключ агента синхронизации.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey?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	SyncAgentKeyProperties	Успешное создание ключа агента синхронизации.
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 — агент синхронизации с таким же идентификатором уже существует.

Примеры

Generate a sync agent key

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

HTTP

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

Java

/**
 * Samples for SyncAgents GenerateKey.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGenerateKey.json
     */
    /**
     * Sample code: Generate a sync agent key.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void generateASyncAgentKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().generateKeyWithResponse("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

{
  "syncAgentKey": "865f9998-6dae-4214-bbb1-4796b7c76ca0:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX="
}

Определения

SyncAgentKeyProperties

Свойства ключа агента синхронизации базы данных Azure SQL.

Имя	Тип	Описание
syncAgentKey	string	Ключ агента синхронизации.