educationSynchronizationProfile-Ressourcentyp

Artikel
10/21/2023

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.

Stellt eine Reihe von Konfigurationen dar, die zum Synchronisieren von Bildungsentitäten und Listeninformationen aus einem Quellverzeichnis mit Microsoft Entra ID verwendet werden. Diese Ressource bietet eine programmgesteuerte Darstellung, die in School Data Sync verwendet wird.

Methoden

Methode	Rückgabetyp	Beschreibung
Auflisten von Profilen	educationSynchronizationProfile-Sammlung	Rufen Sie eine Liste aller Synchronisierungsprofile im Mandanten ab.
Profil abrufen	educationSynchronizationProfile	Rufen Sie ein bestimmtes Profil unter Berücksichtigung des Profilbezeichners ab.
Profil erstellen	Keine	Erstellen Sie ein neues Synchronisierungsprofil.
Profil löschen	educationSynchronizationProfile	Löschen Sie ein bestimmtes Profil unter Berücksichtigung des Profilbezeichners.
Profil anhalten	Keine	Anhalten einer laufenden Synchronisierung.
Profil fortsetzen	Keine	Fortsetzen einer angehaltenen Synchronisierung.
Profil zurücksetzen	Keine	Setzen Sie den Status des Profils zurück, und starten Sie die Synchronisierung neu.
Starten des CSV-Profils	educationFileSynchronizationVerificationMessage-Sammlung	Überprüfen Sie die hochgeladenen Quelldateien, und starten Sie die Synchronisierung. Gilt nur, wenn der Datenanbieter educationCsvDataProvider ist.
Abrufen der CSV-Upload-URL	string	Gibt die kurzlebige URL zum Hochladen von CSV-Datendateien zurück. Gilt nur, wenn der Datenanbieter educationCsvDataProvider ist.
Abrufen status	educationsynchronizationProfileStatus	Gibt die status eines bestimmten Synchronisierungsprofils zurück.
Fehler abrufen	educationSynchronizationError-Sammlung	Ruft alle Fehler ab, die während der Synchronisierung generiert werden.

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	String	Der eindeutige Bezeichner für die Ressource. (schreibgeschützt)
displayName	String	Name des Konfigurationsprofils für die Synchronisierung von Identitäten.
Dataprovider	educationSynchronizationDataProvider	Der für das Profil verwendete Datenanbieter.
expirationDate	Datum	Das Datum, an dem das Profil als abgelaufen betrachtet und die Synchronisierung beendet werden soll. Geben Sie das Datum im `YYYY-MM-DD` Format gemäß ISO 8601 an. Der Maximalwert beträgt 18 Monate ab der Profilerstellung. (optional)
handleSpecialCharacterConstraint	Boolescher Wert	Bestimmt, ob School Data Sync bei der Synchronisierung aus der Quelle automatisch nicht unterstützte Sonderzeichen ersetzen soll.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Bestimmt, wie das Profil neue oder vorhandene Microsoft Entra Benutzer erstellen soll.
licensesToAssign	educationSynchronizationLicenseAssignment-Sammlung	Konfiguration der Lizenzeinrichtung.
state	educationSynchronizationProfileState	Der Status des Profils. Mögliche Werte: `provisioning`, `provisioned`, `provisioningFailed`, `deleting`, `deletionFailed`.

Beziehungen

Beziehung	Typ	Beschreibung
errors	educationSynchronizationError-Sammlung	Alle Fehler, die diesem Synchronisierungsprofil zugeordnet sind.
profileStatus	educationSynchronizationProfileStatus	Die Synchronisierungs-status.

Datenprovider

Jedes educationSynchronizationProfile muss einen der folgenden Datenanbieter angeben, der als Synchronisierungsquelle verwendet werden soll.

Data Provider	Beschreibung
educationCsvDataProvider	CSV-Dateien, die in die SAS-URL des Profils hochgeladen wurden
educationOneRosterApiDataProvider	OneRoster v1.1-API
educationPowerSchoolDataProvider	PowerSchool-API

JSON-Darstellung

Im Folgenden ist eine JSON-Darstellung der EducationSynchronizationProfile-Ressource dargestellt.

{
  "id": "String",
  "displayName": "String",
  "state": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileState"
  },
  "profileStatus": {
    "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
  },
  "errors": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationProfileStatus"
    }
  ],
  "dataProvider": {
    "@odata.type": "microsoft.graph.educationCsvDataProvider"
  },
  "identitySynchronizationConfiguration": {
    "@odata.type": "microsoft.graph.educationIdentitySynchronizationConfiguration"
  },
  "licensesToAssign": [
    {
      "@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment"
    }
  ],
  "handleSpecialCharacterConstraint": "Boolean",
  "expirationDate": "Date"
}