synchronizationJob-Ressourcentyp
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Führt die Synchronisierung durch, indem regelmäßig im Hintergrund ausgeführt wird, änderungen in einem Verzeichnis abgerufen und in ein anderes Verzeichnis gepusht werden. Der Synchronisierungsauftrag ist immer spezifisch für eine bestimmte Instanz einer Anwendung in Ihrem Mandanten. Im Rahmen der Einrichtung des Synchronisierungsauftrags müssen Sie die Berechtigung zum Lesen und Schreiben von Objekten in Ihrem Zielverzeichnis erteilen und das Synchronisierungsschema des Auftrags anpassen.
Methoden
Methode | Rückgabetyp | Beschreibung |
---|---|---|
List | synchronizationJob-Sammlung | Auflisten vorhandener Aufträge für eine bestimmte Anwendungsinstanz (Dienstprinzipal). |
Get | synchronizationJob | Lesen von Eigenschaften und Beziehungen eines synchronizationJob-Objekts. |
Create | synchronizationJob | Erstellen Sie einen neuen Auftrag für eine bestimmte Anwendung. |
Start | Keine | Starten Sie die Synchronisierung. Wenn sich der Auftrag in einem angehaltenen Zustand befindet, wird er ab dem Zeitpunkt fortgesetzt, an dem der Auftrag angehalten wurde. Wenn sich der Auftrag in Quarantäne befindet, wird der Quarantänestatus gelöscht. |
Pause | Keine | Beenden Sie die Synchronisierung vorübergehend. Der gesamte Fortschritt, einschließlich des Auftragsstatus, wird beibehalten, und der Auftrag wird an der Stelle fortgesetzt, an der er bei einem Startaufruf aufgehört hat. |
Restart | Keine | Erzwingen Sie, dass der Auftrag von vorn beginnt und alle Objekte im Verzeichnis neu verarbeitet. |
Delete | Keine | Beenden Sie die Synchronisierung, und löschen Sie den gesamten Status, der dem Auftrag zugeordnet ist. |
Bedarfsgesteuerte Bereitstellung | synchronizationJobApplicationParameters-Auflistung | Stellt die Objekte dar, die bereitgestellt werden, und die ausgeführten Synchronisierungsregeln. Die Ressource wird in erster Linie für die bedarfsgesteuerte Bereitstellung verwendet. |
Überprüfen von Anmeldeinformationen | Keine | Testen Sie die bereitgestellten Anmeldeinformationen anhand des Zielverzeichnisses. |
Eigenschaften
Eigenschaft | Typ | Beschreibung |
---|---|---|
id | Zeichenfolge | Eindeutiger Synchronisierungsauftragsbezeichner. Schreibgeschützt. |
Zeitplan | synchronizationSchedule | Zeitplan, der zum Ausführen des Auftrags verwendet wird. Schreibgeschützt. |
status | synchronizationStatus | Status des Auftrags, der den Zeitpunkt der letzten Ausführung des Auftrags, den aktuellen Auftragsstatus und Fehler umfasst. |
synchronizationJobSettings | keyValuePair | Dem Auftrag zugeordnete Einstellungen. Einige Einstellungen werden von der Vorlage geerbt. |
templateId | Zeichenfolge | Bezeichner der Synchronisierungsvorlage , auf der dieser Auftrag basiert. |
Beziehungen
Beziehung | Typ | Beschreibung |
---|---|---|
bulkUpload | bulkUpload | Der Massenuploadvorgang für den Auftrag. |
Schema | synchronizationSchema | Das für den Auftrag konfigurierte Synchronisierungsschema. |
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
{
"id": "String (identifier)",
"schedule": {
"@odata.type": "microsoft.graph.synchronizationSchedule"
},
"status": {
"@odata.type": "microsoft.graph.synchronizationStatus"
},
"synchronizationJobSettings": {
"@odata.type": "microsoft.graph.keyValuePair"
},
"templateId": "String"
}