Sync Agents - Generate Key

Gera uma chave do 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 de URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

serverName
path True
  • string

O nome do servidor no qual o agente de sincronização está hospedado.

subscriptionId
path True
  • string

A ID de assinatura que identifica uma assinatura do Azure.

syncAgentName
path True
  • string

O nome do agente de sincronização.

api-version
query True
  • string

A versão da API a ser usada para a solicitação.

Respostas

Name Type Description
200 OK

Gere com êxito uma chave do agente de sincronização.

Other Status Codes

Respostas de erro: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - O corpo da solicitação do grupo de sincronização criar ou atualizar está vazio.

  • 400 InvalidSyncMemberCreateOrUpdateRequest - O corpo da solicitação do membro de criação ou atualização da sincronização está vazio.

  • 400 InvalidSyncAgentCreateOrUpdateRequest - O corpo da solicitação do agente de criação ou atualização está vazio.

  • 400 InvalidDatabaseResourceId – Identificador de recurso de banco de dados inválido.

  • 400 MismatchingSubscriptionWithUrl - A assinatura fornecida não correspondeu à assinatura na URL.

  • 400 InvalidSyncAgentResourceId - Identificador de recurso do agente de sincronização inválido.

  • 400 MismatchingResourceGroupNameWithUrl - O nome do grupo de recursos fornecido não correspondeu ao nome na URL.

  • 400 MismatchingServerNameWithUrl - O nome do servidor fornecido não correspondeu ao nome na URL.

  • 400 InvalidParameterValue - Um valor inválido foi dado a um parâmetro.

  • 400 MissingServerName - O nome do servidor está ausente

  • 400 MissingDatabaseName - O nome do banco de dados está ausente

  • 400 MissingSyncGroupName - O nome do Grupo de Sincronização está ausente

  • 400 MissingConflictResolutionPolicy - A Política de Resolução de Conflitos está ausente

  • 400 MissingSyncAgentName – O nome do Agente de Sincronização está ausente

  • 400 SyncOperation_GenericFailure – falha ao executar a operação de sincronização de dados.

  • 400 SyncOperation_WrongSyncDatabase – o banco de dados de sincronização especificado não corresponde ao existente.

  • 400 SyncOperation_DwInSyncGroup – Não é possível usar a edição datawarehouse na sincronização de dados.

  • 400 SyncOperation_MasterDbInSyncGroup – não é possível usar o mestre lógico na sincronização de dados.

  • 400 CannotDeleteInUseSyncAgent - Não é possível excluir o agente de sincronização porque ele é usado pelo membro de sincronização.

  • 400 InvalidSyncAgent – O agente de sincronização é inválido.

  • 400 InvalidSyncMetadataDatabase - O banco de dados de metadados de sincronização é inválido.

  • 404 ResourceNotFound - O recurso solicitado não foi encontrado.

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 DatabaseDoesNotExist – O usuário especificou um nome de banco 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 a mesma ID já existe.

Exemplos

Generate a sync agent key

Sample Request

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

Sample Response

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

Definições

SyncAgentKeyProperties

Propriedades de uma chave do agente de sincronização de banco de dados SQL do Azure.

Name Type Description
syncAgentKey
  • string

Chave do agente de sincronização.