Sync Agents - Create Or Update

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Cria ou atualiza um agente de sincronização.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	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.

Corpo da solicitação

Nome	Tipo	Description
properties.syncDatabaseId	string	ID de recurso do ARM do banco de dados de sincronização no agente de sincronização.

Respostas

Nome	Tipo	Description
200 OK	SyncAgent	O agente de sincronização foi atualizado com êxito.
201 Created	SyncAgent	O agente de sincronização foi criado com êxito.
202 Accepted		A criação ou atualização do agente de sincronização está em andamento.
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 sincronização criar ou atualizar está vazio. 400 InvalidSyncAgentCreateOrUpdateRequest - O corpo da solicitação do agente de sincronização 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 master lógicas 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 de servidor. 404 OperationIdNotFound - A operação com Id não existe. 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. 409 OperationCancelled - A operação foi cancelada pelo usuário. 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

Exemplos

Create a new sync agent

Update a sync agent

Create a new sync agent

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/**
 * Samples for SyncAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentCreate.json
     */
    /**
     * Sample code: Create a new sync agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createANewSyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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 de exemplo

Código de status:: 200

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

Código de status:: 201

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

Código de status:: 202

Update a sync agent

Solicitação de exemplo

HTTP
Java

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

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/**
 * Samples for SyncAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentUpdate.json
     */
    /**
     * Sample code: Update a sync agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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 de exemplo

Código de status:: 200

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

Código de status:: 201

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

Código de status:: 202

Definições

Nome	Description
SyncAgent	Um agente de sincronização do banco de dados SQL do Azure.
SyncAgentState	Estado do agente de sincronização.

SyncAgent

Object

Um agente de sincronização do banco de dados SQL do Azure.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.expiryTime	string	Hora de expiração da versão do agente de sincronização.
properties.isUpToDate	boolean	Se a versão do agente de sincronização estiver atualizada.
properties.lastAliveTime	string	Última hora ativa do agente de sincronização.
properties.name	string	Nome do agente de sincronização.
properties.state	SyncAgentState	Estado do agente de sincronização.
properties.syncDatabaseId	string	ID de recurso do ARM do banco de dados de sincronização no agente de sincronização.
properties.version	string	Versão do agente de sincronização.
type	string	Tipo de recurso.

SyncAgentState

Enumeration

Estado do agente de sincronização.

Valor	Description
NeverConnected
Offline
Online

Compartilhar via

Sync Agents - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a new sync agent

Solicitação de exemplo

Resposta de exemplo

Update a sync agent

Solicitação de exemplo

Resposta de exemplo

Definições

SyncAgent

SyncAgentState

Recursos adicionais