educationSynchronizationProfile-Ressourcentyp

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Stellt eine Reihe von Konfigurationen dar, die zum Synchronisieren von Bildungsentitäten und Listeninformationen aus einem Quellverzeichnis mit Azure Active Directory (Azure AD) verwendet werden. Diese Ressource bietet eine programmgesteuerte Darstellung, die in School Data Sync verwendet wird.

Methoden

Methode	Rückgabetyp	Beschreibung
Profile auflisten	[educationSynchronizationProfile-Sammlung]	Dient zum Abrufen einer Liste aller Synchronisierungsprofile im Mandanten.
Profil abrufen	educationSynchronizationProfile	Ruft ein bestimmtes Profil ab, wenn der Profilbezeichner angegeben ist.
Profil erstellen	Keine	Erstellen Sie ein neues Synchronisierungsprofil.
Profil löschen	educationSynchronizationProfile	Löschen Sie ein bestimmtes Profil mit dem Profilbezeichner.
Profil anhalten	Keine	Anhalten einer laufenden Synchronisierung.
Profil fortsetzen	Keine	Setzen Sie eine angehaltene Synchronisierung fort.
Profil zurücksetzen	Keine	Setzen Sie den Status des Profils zurück, und starten Sie die Synchronisierung neu.
Starten des CSV-Profils	[educationFileSynchronizationVerificationMessagecollection]	Überprüfen Sie die hochgeladenen Quelldateien, und starten Sie die Synchronisierung. Gilt nur, wenn der Datenanbieter educationCsvDataProvider ist.
ABRUFEN DER CSV-Upload-URL	string	Zurückgeben der kurzlebigen URL zum Hochladen von CSV-Datendateien. Gilt nur, wenn der Datenanbieter educationCsvDataProvider ist.
Status abrufen	educationsynchronizationProfileStatus	Gibt den Status eines bestimmten Synchronisierungsprofils zurück.
Fehler abrufen	[educationSynchronizationError-Sammlung]	Rufen Sie alle Fehler ab, die während der Synchronisierung generiert wurden.

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	Zeichenfolge	Der eindeutige Bezeichner für die Ressource. (schreibgeschützt)
displayName	Zeichenfolge	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 werden sollte und die Synchronisierung eingestellt werden soll. Geben Sie das Datum im YYYY-MM-DD Format nach 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 eine neue erstellen oder mit vorhandenen AAD Benutzern übereinstimmen soll.
licensesToAssign	[educationSynchronizationLicenseAssignment-Sammlung]	Lizenzeinrichtungskonfiguration.
state	educationSynchronizationProfileState	Der Status des Profils. Mögliche Werte: provisioning, provisioned, provisioningFailed, deleting, deletionFailed.

Beziehungen

Beziehung	Typ	Beschreibung
errors	[educationSynchronizationError-Sammlung]	Alle Fehler im Zusammenhang mit diesem Synchronisierungsprofil.
profileStatus	educationSynchronizationProfileStatus	Der Synchronisierungsstatus.

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

Es folgt eine JSON-Darstellung der educationSynchronizationProfile-Ressource .

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