tipo de recurso synchronizationJob

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Realiza la sincronización ejecutándose periódicamente en segundo plano, sondeando los cambios en un directorio e insertándolos en otro directorio. El trabajo de sincronización siempre es específico de una instancia concreta de una aplicación en el inquilino. Como parte de la configuración del trabajo de sincronización, debe conceder autorización para leer y escribir objetos en el directorio de destino y personalizar el esquema de sincronización del trabajo.

Métodos

Método Tipo de valor devuelto Descripción
List sincronizaciónColección de trabajos Enumerar los trabajos existentes para una instancia de aplicación determinada (entidad de servicio).
Get synchronizationJob Lea las propiedades y relaciones de un objeto synchronizationJob.
Crear synchronizationJob Crear un nuevo trabajo para una aplicación determinada.
Start Ninguno Iniciar la sincronización. Si el trabajo está en un estado de pausa, continúa desde el punto en el que se pausó el trabajo. Si el trabajo está en cuarentena, se borrará el estado de cuarentena.
Pause Ninguno Detener temporalmente la sincronización. Todo el progreso, incluido el estado del trabajo, se conserva y el trabajo continuará desde donde lo dejó cuando se realice una llamada de inicio .
Restart Ninguno Forzar el trabajo para que se inicie de nuevo y volver a procesar todos los objetos del directorio.
Delete Ninguno Detenga la sincronización y elimine permanentemente todo el estado asociado con el trabajo.
Aprovisionamiento bajo demanda Colección synchronizationJobApplicationParameters Representa los objetos que se aprovisionarán y las reglas de sincronización que se ejecutarán. El recurso se usa principalmente para el aprovisionamiento a petición.
Validar credenciales Ninguno Pruebe las credenciales proporcionadas en el directorio de destino.

Propiedades

Propiedad Tipo Descripción
id Cadena Identificador único del trabajo de sincronización. Solo lectura.
schedule synchronizationSchedule Programación usada para ejecutar el trabajo. Solo lectura.
status synchronizationStatus Estado del trabajo, que incluye cuándo se ejecutó por última vez el trabajo, el estado actual del trabajo y los errores.
synchronizationJobSettings keyValuePair Configuración asociada con el trabajo. Algunas configuraciones se heredan de la plantilla.
templateId Cadena Identificador de la plantilla de sincronización en la que se basa este trabajo.

Relaciones

Relación Tipo Description
bulkUpload bulkUpload La operación de carga masiva para el trabajo.
objectConnections Colección objectConnection Los registros de vinculación del almacén de datos del conector contenidos por el trabajo. Durante la versión preliminar pública, recupere una conexión individual con un objectId conocido o elimínela para borrar su vinculación almacenada en caché. La lista de colecciones no se admite y devuelve 400 Bad Request.
esquema synchronizationSchema El esquema de sincronización configurado para el trabajo.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "id": "String (identifier)",
  "schedule": {
    "@odata.type": "microsoft.graph.synchronizationSchedule"
  },
  "status": {
    "@odata.type": "microsoft.graph.synchronizationStatus"
  },
  "synchronizationJobSettings": {
    "@odata.type": "microsoft.graph.keyValuePair"
  },
  "templateId": "String"
}