synchronisationType de ressource de tâche

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Effectue la synchronisation en s’exécutant périodiquement en arrière-plan, en interrogeant les modifications dans un répertoire et en les poussant vers un autre répertoire. La tâche de synchronisation est toujours spécifique à un instance particulier d’une application dans votre client. Dans le cadre de la configuration de la tâche de synchronisation, vous devez autoriser la lecture et l’écriture d’objets dans votre répertoire cible et personnaliser le schéma de synchronisation de la tâche.

Méthodes

Méthode Type renvoyé Description
List synchronisationcollection de tâches Répertorier les travaux existants pour une instance d’application donnée (principal de service).
Obtenir synchronizationJob Lire les propriétés et les relations d’un objet synchronizationJob.
Create synchronizationJob Créer un nouveau travail pour une application donnée.
Start Aucun Démarrez la synchronisation. Si le travail est dans un état suspendu, il continue à partir du point où le travail a été suspendu. Si le travail est en quarantaine, le status de quarantaine est effacé.
Pause Aucun Arrêter temporairement la synchronisation. Toute la progression, y compris l’état du travail, est conservée et le travail reprend là où il s’est arrêté lorsqu’un appel de démarrage est effectué.
Restart Aucun Forcez le redémarrage de la tâche et retraitez tous les objets du répertoire.
Supprimer Aucun Arrêter la synchronisation et supprimer définitivement tout l’état associé à la tâche.
Provisionnement à la demande synchronizationJobApplicationParameters Représente les objets qui seront approvisionnés et les règles de synchronisation exécutées. La ressource est principalement utilisée pour l’approvisionnement à la demande.
Valider les informations d’identification Aucun Testez les informations d’identification fournies par rapport au répertoire cible.

Propriétés

Propriété Type Description
id String Identificateur unique du travail de synchronisation. En lecture seule.
planifier synchronizationSchedule Planification utilisée pour exécuter le travail. En lecture seule.
status synchronisationÉtat État de la tâche, qui inclut la date de la dernière exécution de la tâche, l’état actuel de la tâche et les erreurs.
synchronizationJobSettings keyValuePair Paramètres associés à la tâche. Certains paramètres sont hérités du modèle.
templateId String Identificateur du modèle de synchronisation sur lequel ce travail est basé.

Relations

Relation Type Description
Téléchargement en bloc Téléchargement en bloc Opération de téléchargement en bloc du travail.
objectConnections collection objectConnection Enregistrements de liaison de magasin de données de connecteur contenus dans la tâche. Pendant la préversion publique, récupérez une connexion individuelle à l’aide d’un objectId connu ou supprimez-la pour effacer sa liaison mise en cache. La liste des collections n’est pas prise en charge et renvoie 400 Bad Request.
schéma synchronizationSchema Schéma de synchronisation configuré pour le travail.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

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