Sync Agents - Create Or Update

Riferimento

Service:: SQL Database

API Version:: 2021-11-01

Crea o aggiorna un agente di sincronizzazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
serverName	path	True	string	Nome del server in cui è ospitato l'agente di sincronizzazione.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
syncAgentName	path	True	string	Nome dell'agente di sincronizzazione.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.syncDatabaseId	string	ID risorsa ARM del database di sincronizzazione nell'agente di sincronizzazione.

Risposte

Nome	Tipo	Descrizione
200 OK	SyncAgent	Aggiornato correttamente l'agente di sincronizzazione.
201 Created	SyncAgent	È stato creato correttamente l'agente di sincronizzazione.
202 Accepted		La creazione o l'aggiornamento dell'agente di sincronizzazione è in corso.
Other Status Codes		Risposte agli errori: ** 400 InvalidSyncGroupCreateOrUpdateRequest: il corpo della richiesta del gruppo di sincronizzazione crea o aggiorna è vuoto. 400 InvalidSyncMemberCreateOrUpdateRequest: il corpo della richiesta membro di creazione o aggiornamento della sincronizzazione è vuoto. 400 InvalidSyncAgentCreateOrUpdateRequest: il corpo della richiesta dell'agente di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidDatabaseResourceId - Identificatore di risorsa del database non valido. 400 Mancata corrispondenzaSubscriptionWithUrl: la sottoscrizione specificata non corrispondeva alla sottoscrizione nell'URL. 400 InvalidSyncAgentResourceId - Identificatore di risorsa dell'agente di sincronizzazione non valido. 400 MismatchingResourceGroupNameWithUrl: il nome del gruppo di risorse specificato non corrisponde al nome nell'URL. 400 MismatchingServerNameWithUrl: il nome del server specificato non corrisponde al nome nell'URL. 400 InvalidParameterValue: un valore non valido è stato assegnato a un parametro. 400 MissingServerName - Nome server mancante 400 MissingDatabaseName - Nome database mancante 400 MissingSyncGroupName - Il nome del gruppo di sincronizzazione manca 400 MissingConflictResolutionPolicy - Manca il criterio di risoluzione dei conflitti 400 MissingSyncAgentName - Il nome dell'agente di sincronizzazione manca 400 SyncOperation_GenericFailure - Impossibile eseguire l'operazione di sincronizzazione dei dati. 400 SyncOperation_WrongSyncDatabase: il database di sincronizzazione specificato non corrisponde a quello esistente. 400 SyncOperation_DwInSyncGroup - Impossibile usare l'edizione datawarehouse nella sincronizzazione dei dati. 400 SyncOperation_MasterDbInSyncGroup - Impossibile usare master logico nella sincronizzazione dei dati. 400 CannotDeleteInUseSyncAgent - Impossibile eliminare l'agente di sincronizzazione perché viene usato dal membro di sincronizzazione. 400 InvalidSyncAgent - Agente di sincronizzazione non valido. 400 InvalidSyncMetadataDatabase - Il database dei metadati di sincronizzazione non è valido. 404 ResourceNotFound : la risorsa richiesta non è stata trovata. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 DatabaseDoesNotExist: l'utente ha specificato un nome di database che non esiste in questa istanza del server. 404 OperationIdNotFound: l'operazione con ID non esiste. 409 SyncOperation_AgentAlreadyExists : l'agente di sincronizzazione con lo stesso nome esiste già. 409 SyncOperation_AgentIdAlreadyExists : l'agente di sincronizzazione con lo stesso ID esiste già. 409 OperationCancelled: l'operazione è stata annullata dall'utente. 409 Operazione interrotta: impossibile completare l'operazione sulla risorsa perché è stata interrotta da un'altra operazione sulla stessa risorsa. 429 SubscriptionTooManyCreateUpdateRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili. 429 SubscriptionTooManyRequests - Richieste oltre le richieste massime che possono essere elaborate dalle risorse disponibili. 500 OperationTimedOut: l'operazione viene timeout e viene eseguito automaticamente il rollback. Ripetere l'operazione. 503 TooManyRequests : richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

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.core.util.Context;
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"),
            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

Sample Response

Status code:: 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"
}

Status code:: 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"
}

Status code:: 202

Update a sync agent

Sample Request

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.core.util.Context;
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"),
            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

Sample Response

Status code:: 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"
}

Status code:: 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"
}

Status code:: 202

Definizioni

Nome	Descrizione
SyncAgent	Agente di sincronizzazione del database Azure SQL.
SyncAgentState	Stato dell'agente di sincronizzazione.

SyncAgent

Agente di sincronizzazione del database Azure SQL.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.expiryTime	string	Data di scadenza della versione dell'agente di sincronizzazione.
properties.isUpToDate	boolean	Se la versione dell'agente di sincronizzazione è aggiornata.
properties.lastAliveTime	string	Ultima ora attiva dell'agente di sincronizzazione.
properties.name	string	Nome dell'agente di sincronizzazione.
properties.state	SyncAgentState	Stato dell'agente di sincronizzazione.
properties.syncDatabaseId	string	ID risorsa ARM del database di sincronizzazione nell'agente di sincronizzazione.
properties.version	string	Versione dell'agente di sincronizzazione.
type	string	Tipo di risorsa.

SyncAgentState

Stato dell'agente di sincronizzazione.

Nome	Tipo	Descrizione
NeverConnected	string
Offline	string
Online	string

Sync Agents - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Create a new sync agent

Sample Request

Sample Response

Update a sync agent

Sample Request

Sample Response

Definizioni

SyncAgent

SyncAgentState

Risorse aggiuntive