Delen via

Sync Agents - List By Server

  • Referentie
Service:
SQL Database
API-versie:
2021-11-01

Lijsten synchronisatieagents op een server.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName
 path True

string

De naam van de server waarop de synchronisatieagent wordt gehost.
subscriptionId
 path True

string

De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version
 query True

string

De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name Type Description
200 OK

SyncAgentListResult

De lijst met synchronisatieagents is opgehaald.
Other Status Codes

Foutreacties: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest - De aanvraagtekst voor het maken of bijwerken van de synchronisatiegroep is leeg.

  • 400 InvalidSyncMemberCreateOrUpdateRequest - De aanvraagtekst van het synchronisatielid maken of bijwerken is leeg.

  • 400 InvalidSyncAgentCreateOrUpdateRequest - De aanvraagtekst van de synchronisatieagent maken of bijwerken is leeg.

  • 400 InvalidDatabaseResourceId - Ongeldige databaseresource-id.

  • 400 Komt niet overeenSubscriptionWithUrl: het opgegeven abonnement komt niet overeen met het abonnement in de URL.

  • 400 InvalidSyncAgentResourceId - Ongeldige resource-id van de synchronisatieagent.

  • 400 Komt niet overeenResourceGroupNameWithUrl - De opgegeven naam van de resourcegroep komt niet overeen met de naam in de URL.

  • 400 MismatchingServerNameWithUrl - De opgegeven servernaam komt niet overeen met de naam in de URL.

  • 400 InvalidParameterValue - Er is een ongeldige waarde gegeven aan een parameter.

  • 400 MissingServerName - De servernaam ontbreekt

  • 400 MissingDatabaseName - De databasenaam ontbreekt

  • 400 MissingSyncGroupName - De naam van de synchronisatiegroep ontbreekt

  • 400 MissingConflictResolutionPolicy - Het beleid voor conflictoplossing ontbreekt

  • 400 MissingSyncAgentName - De naam van de synchronisatieagent ontbreekt

  • 400 SyncOperation_GenericFailure : kan de gegevenssynchronisatiebewerking niet uitvoeren.

  • 400 SyncOperation_WrongSyncDatabase: de opgegeven synchronisatiedatabase komt niet overeen met de bestaande database.

  • 400 SyncOperation_DwInSyncGroup : kan de datawarehouse-editie niet gebruiken in gegevenssynchronisatie.

  • 400 SyncOperation_MasterDbInSyncGroup: kan logische master niet gebruiken in gegevenssynchronisatie.

  • 400 CannotDeleteInUseSyncAgent - Kan de synchronisatieagent niet verwijderen omdat deze wordt gebruikt door het synchronisatielid.

  • 400 InvalidSyncAgent - Synchronisatieagent is ongeldig.

  • 400 InvalidSyncMetadataDatabase - Database met synchronisatiemetagegevens is ongeldig.

  • 404 ResourceNotFound - De aangevraagde resource is niet gevonden.

  • 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

  • 404 DatabaseDoesNotExist - Gebruiker heeft een databasenaam opgegeven die niet bestaat op dit serverexemplaren.

  • 409 SyncOperation_AgentAlreadyExists - De synchronisatieagent met dezelfde naam bestaat al.

  • 409 SyncOperation_AgentIdAlreadyExists - De synchronisatieagent met dezelfde id bestaat al.

Voorbeelden

Get sync agents under a server

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
    }
  ]
}

Definities

Name Description
SyncAgent

Een Azure SQL Database-synchronisatieagent.
SyncAgentListResult

Een lijst met synchronisatieagents.
SyncAgentState

Status van de synchronisatieagent.

SyncAgent

Object

Een Azure SQL Database-synchronisatieagent.

Name Type Description
id

string

Resource-id.
name

string

Resourcenaam.
properties.expiryTime

string

Verlooptijd van de versie van de synchronisatieagent.
properties.isUpToDate

boolean

Als de versie van de synchronisatieagent up-to-date is.
properties.lastAliveTime

string

De laatste keer dat de synchronisatieagent actief is.
properties.name

string

Naam van de synchronisatieagent.
properties.state

SyncAgentState

Status van de synchronisatieagent.
properties.syncDatabaseId

string

ARM-resource-id van de synchronisatiedatabase in de synchronisatieagent.
properties.version

string

Versie van de synchronisatieagent.
type

string

Resourcetype.

SyncAgentListResult

Object

Een lijst met synchronisatieagents.

Name Type Description
nextLink

string

Koppeling om de volgende pagina met resultaten op te halen.
value

SyncAgent[]

Matrix met resultaten.

SyncAgentState

Enumeration

Status van de synchronisatieagent.

Waarde Description
NeverConnected
Offline
Online