Sync Agents - Generate Key

Serviço:

SQL Database

Versão da API:

2021-11-01

Gera uma chave de agente de sincronização.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor no qual o agente de sincronização está alojado.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
syncAgentName	path	True	string	O nome do agente de sincronização.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	SyncAgentKeyProperties	Gerar com êxito uma chave de agente de sincronização.
Other Status Codes		Respostas de Erro: *** 400 InvalidSyncGroupCreateOrUpdateRequest - O corpo do pedido de grupo de sincronização de criação ou atualização está vazio. 400 InvalidSyncMemberCreateOrUpdateRequest - O corpo do pedido de membro de sincronização de criação ou atualização está vazio. 400 InvalidSyncAgentCreateOrUpdateRequest - O corpo do pedido do agente de sincronização de criação ou atualização está vazio. 400 InvalidDatabaseResourceId – identificador de recurso de base de dados inválido. 400 MismatchingSubscriptionWithUrl – a subscrição fornecida não corresponde à subscrição no Url. 400 InvalidSyncAgentResourceId - Identificador de recurso do agente de sincronização inválido. 400 MismatchingResourceGroupNameWithUrl – o nome do grupo de recursos fornecido não corresponde ao nome no Url. 400 MismatchingServerNameWithUrl – o nome do servidor fornecido não corresponde ao nome no Url. 400 InvalidParameterValue – foi atribuído um valor inválido a um parâmetro. 400 MissingServerName - O nome do servidor está em falta 400 MissingDatabaseName – O nome da base de dados está em falta 400 MissingSyncGroupName – O nome do Grupo de Sincronização está em falta 400 MissingConflictResolutionPolicy - A Política de Resolução de Conflitos está em falta 400 MissingSyncAgentName – O nome do Agente de Sincronização está em falta 400 SyncOperation_GenericFailure – Falha ao executar a operação de sincronização de dados. 400 SyncOperation_WrongSyncDatabase – a base de dados de sincronização especificada não corresponde à existente. 400 SyncOperation_DwInSyncGroup - Não é possível utilizar a edição datawarehouse na sincronização de dados. 400 SyncOperation_MasterDbInSyncGroup – não é possível utilizar o mestre lógico na sincronização de dados. 400 CannotDeleteInUseSyncAgent – não é possível eliminar o agente de sincronização porque é utilizado pelo membro de sincronização. 400 InvalidSyncAgent - O agente de sincronização é inválido. 400 InvalidSyncMetadataDatabase - A base de dados de metadados de sincronização é inválida. 404 ResourceNotFound – o recurso pedido não foi encontrado. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 DatabaseDoesNotExist – o utilizador especificou um nome de base de dados que não existe nesta instância do servidor. 409 SyncOperation_AgentAlreadyExists - O agente de sincronização com o mesmo nome já existe. 409 SyncOperation_AgentIdAlreadyExists - O agente de sincronização com o mesmo ID já existe.

Exemplos

Generate a sync agent key

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

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

Definições

SyncAgentKeyProperties

Object

Propriedades de uma chave de agente de sincronização da Base de Dados SQL do Azure.

Name	Tipo	Description
syncAgentKey	string	Chave do agente de sincronização.