Sync Agents - List By Server

Servizio:

SQL Database

Versione API:

2023-08-01

Elenca gli agenti di sincronizzazione in un server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents?api-version=2023-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager 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.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	SyncAgentListResult	È stato recuperato l'elenco degli agenti di sincronizzazione.
Other Status Codes	ErrorResponse	Risposte di errore: 400 InvalidSyncGroupCreateOrUpdateRequest: il corpo della richiesta del gruppo di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidSyncMemberCreateOrUpdateRequest- Il corpo della richiesta del membro di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidSyncAgentCreateOrUpdateRequest: il corpo della richiesta dell'agente di sincronizzazione di creazione o aggiornamento è vuoto. 400 InvalidDatabaseResourceId - Identificatore di risorsa di database non valido. 400 InvalidSyncGroupName - Il nome del gruppo di sincronizzazione non è valido. Questo campo può contenere lettere, numeri, trattini e caratteri di sottolineatura. 400 InvalidSyncMemberName- Il nome del membro di sincronizzazione non è valido. Questo campo può contenere lettere, numeri, trattini e caratteri di sottolineatura. 400 MissingSyncMemberName - Manca il nome del membro di sincronizzazione 400 InvalidSyncGroupInterval: l'intervallo di sincronizzazione deve essere maggiore o uguale a 5 secondi. 400 Mancata corrispondenzaSubscriptionWithUrl: la sottoscrizione specificata non corrisponde alla sottoscrizione nell'URL. 400 InvalidSyncAgentResourceId - Identificatore di risorsa dell'agente di sincronizzazione non valido. 400 Mancata corrispondenzaResourceGroupNameWithUrl- 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- È stato assegnato un valore non valido a un parametro. 400 MissingServerName - Manca il nome del server 400 MissingDatabaseName - Nome database mancante 400 MissingSyncGroupName - Manca il nome del gruppo di sincronizzazione 400 MissingConflictResolutionPolicy - Manca il criterio di risoluzione dei conflitti 400 MissingSyncAgentName - Manca il nome dell'agente di sincronizzazione 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 - Non è possibile usare l'edizione datawarehouse nella sincronizzazione dati. 400 SyncOperation_MasterDbInSyncGroup : non è possibile usare il master logico nella sincronizzazione dati. 400 CannotDeleteInUseSyncAgent - Impossibile eliminare l'agente di sincronizzazione perché viene usato dal membro di sincronizzazione. 400 InvalidSyncAgent - L'agente di sincronizzazione non è valido. 400 InvalidSyncMetadataDatabase - Il database dei metadati di sincronizzazione non è valido. 404 ResourceNotFound: la risorsa richiesta non è stata trovata. 404 SubscriptionNotFound - La sottoscrizione 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. 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à. 429 SubscriptionTooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili. 503 TooManyRequests - Richieste oltre il numero massimo di richieste che possono essere elaborate dalle risorse disponibili.

Esempio

Get sync agents under a server

Esempio di richiesta

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SyncAgentListByServer.json
// this example is just showing the usage of "SyncAgents_ListByServer" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncagentcrud-65440";
string serverName = "syncagentcrud-8475";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SyncAgentResource
SyncAgentCollection collection = sqlServer.GetSyncAgents();

// invoke the operation and iterate over the result
await foreach (SyncAgentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SyncAgentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "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"
    }
  ]
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
SyncAgent	Un agente di sincronizzazione del database SQL di Azure.
SyncAgentListResult	Elenco di agenti di sincronizzazione.
SyncAgentState	Stato dell'agente di sincronizzazione.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

SyncAgent

Object

Un agente di sincronizzazione del database SQL di Azure.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.expiryTime	string (date-time)	Scadenza della versione dell'agente di sincronizzazione.
properties.isUpToDate	boolean	Se la versione dell'agente di sincronizzazione è aggiornata.
properties.lastAliveTime	string (date-time)	Ora dell'ultima esecuzione 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.

SyncAgentListResult

Object

Elenco di agenti di sincronizzazione.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	SyncAgent[]	Matrice di risultati.

SyncAgentState

Enumerazione

Stato dell'agente di sincronizzazione.

Valore	Descrizione
Online
Offline
NeverConnected