Compartir a través de

Sync Agents - Get

  • Referencia
Servicio:
SQL Database
Versión de la API:
2023-08-01

Obtiene un agente de sincronización.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName
 path True

string

Nombre del servidor en el que se hospeda el agente de sincronización.
subscriptionId
 path True

string

Identificador de suscripción que identifica una suscripción de Azure.
syncAgentName
 path True

string

Nombre del agente de sincronización.
api-version
 query True

string

Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre Tipo Description
200 OK

SyncAgent

Recuperó correctamente el agente de sincronización especificado.
Other Status Codes

ErrorResponse

Respuestas de error: ***

  • 400 InvalidSyncGroupCreateOrUpdateRequest: el cuerpo de la solicitud de grupo de sincronización de creación o actualización está vacío.

  • 400 InvalidSyncMemberCreateOrUpdateRequest: el cuerpo de la solicitud de miembro de creación o actualización de la sincronización está vacío.

  • 400 InvalidSyncAgentCreateOrUpdateRequest: el cuerpo de la solicitud del agente de sincronización de creación o actualización está vacío.

  • 400 InvalidDatabaseResourceId: identificador de recurso de base de datos no válido.

  • 400 InvalidSyncGroupName: el nombre del grupo de sincronización no es válido. Este campo puede contener letras, números, guiones y caracteres de subrayado.

  • 400 InvalidSyncMemberName: el nombre del miembro de sincronización no es válido. Este campo puede contener letras, números, guiones y caracteres de subrayado.

  • 400 MissingSyncMemberName: falta el nombre del miembro de sincronización

  • 400 InvalidSyncGroupInterval: el intervalo de sincronización debe ser mayor o igual que 5 segundos.

  • 400 No coincidentesSubscriptionWithUrl: la suscripción proporcionada no coincide con la suscripción en la dirección URL.

  • 400 InvalidSyncAgentResourceId: identificador de recursos del agente de sincronización no válido.

  • 400 No coincidentesResourceGroupNameWithUrl: el nombre del grupo de recursos proporcionado no coincide con el nombre en la dirección URL.

  • 400 No coincidentesServerNameWithUrl: el nombre del servidor proporcionado no coincide con el nombre de la dirección URL.

  • 400 InvalidParameterValue: se ha proporcionado un valor no válido a un parámetro.

  • 400 MissingServerName: falta el nombre del servidor

  • 400 MissingDatabaseName: falta el nombre de la base de datos

  • 400 MissingSyncGroupName: falta el nombre del grupo de sincronización

  • 400 MissingConflictResolutionPolicy: falta la directiva de resolución de conflictos

  • 400 MissingSyncAgentName: falta el nombre del agente de sincronización

  • 400 SyncOperation_GenericFailure: no se pudo realizar la operación de sincronización de datos.

  • 400 SyncOperation_WrongSyncDatabase: la base de datos de sincronización especificada no coincide con la existente.

  • 400 SyncOperation_DwInSyncGroup: no se puede usar datawarehouse edition en la sincronización de datos.

  • 400 SyncOperation_MasterDbInSyncGroup: no se puede usar el patrón lógico en la sincronización de datos.

  • 400 CannotDeleteInUseSyncAgent: no se puede eliminar el agente de sincronización porque lo usa el miembro de sincronización.

  • 400 InvalidSyncAgent: el agente de sincronización no es válido.

  • 400 InvalidSyncMetadataDatabase: la base de datos de metadatos de sincronización no es válida.

  • 404 ResourceNotFound: no se encontró el recurso solicitado.

  • 404 SubscriptionNotFound: no se encontró la suscripción solicitada.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

  • 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.

  • 409 SyncOperation_AgentAlreadyExists: el agente de sincronización con el mismo nombre ya existe.

  • 409 SyncOperation_AgentIdAlreadyExists: el agente de sincronización con el mismo identificador ya existe.

  • 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.

  • 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

Get a sync agent

Solicitud de ejemplo

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

Respuesta de muestra

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"
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
SyncAgent

Un agente de sincronización de Azure SQL Database.
SyncAgentState

Estado del agente de sincronización.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

SyncAgent

Object

Un agente de sincronización de Azure SQL Database.

Nombre Tipo Description
id

string

Identificador de recurso.
name

string

Nombre del recurso.
properties.expiryTime

string (date-time)

Hora de expiración de la versión del agente de sincronización.
properties.isUpToDate

boolean

Si la versión del agente de sincronización está actualizada.
properties.lastAliveTime

string (date-time)

Hora de última vida del agente de sincronización.
properties.name

string

Nombre del agente de sincronización.
properties.state

SyncAgentState

Estado del agente de sincronización.
properties.syncDatabaseId

string

Identificador de recurso de ARM de la base de datos de sincronización en el agente de sincronización.
properties.version

string

Versión del agente de sincronización.
type

string

Tipo de recurso.

SyncAgentState

Enumeración

Estado del agente de sincronización.

Valor Description
NeverConnected
Offline
Online