Type de ressource educationSynchronizationProfile (déconseillé)

Article
07/23/2024

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 .

Attention

L’API profil de synchronisation Éducation est déconseillée et cessera de retourner des données le 31 décembre 2024. Pour plus d’informations sur la migration vers la nouvelle API de données industrielles, consultez Transition à partir de School Data Sync (classique) .

Représente un ensemble de configurations utilisées pour synchroniser les informations des entités d’éducation et de la liste de travail à partir d’un répertoire source avec l’ID Microsoft Entra. Cette ressource fournit une représentation programmatique utilisée dans School Data Sync.

Méthodes

Méthode	Type renvoyé	Description
Répertorier les profils	collection educationSynchronizationProfile	Obtenez la liste de tous les profils de synchronisation dans le locataire.
Obtenir un profil	educationSynchronizationProfile	Récupérez un profil spécifique en fonction de l’identificateur du profil.
Créer un profil	educationSynchronizationProfile	Créez un profil de synchronisation.
Mettre à jour le profil	educationSynchronizationProfile	Mettez à jour les propriétés d’un profil de synchronisation de données scolaire existant dans le locataire.
Suppression du profil	Néant	Supprimez un profil spécifique en fonction de l’identificateur du profil.
Suspendre le profil	Aucune	Suspendre une synchronisation en cours.
Profil de reprise	Aucune	Reprendre une synchronisation suspendue.
Réinitialiser le profil	Aucune	Réinitialisez l’état du profil et redémarrez la synchronisation.
Démarrer le profil CSV	collection educationFileSynchronizationVerificationMessage	Vérifiez les fichiers sources chargés et démarrez la synchronisation. S’applique uniquement lorsque le fournisseur de données est educationCsvDataProvider.
Obtenir l’URL de chargement CSV	string	Retourne l’URL de courte durée pour charger des fichiers de données CSV. S’applique uniquement lorsque le fournisseur de données est educationCsvDataProvider.
Obtenir l’état	educationsynchronizationProfileStatus	Retourne l’état d’un profil de synchronisation spécifique.
Obtenir les erreurs	collection educationSynchronizationError	Obtient toutes les erreurs générées pendant la synchronisation.

Propriétés

Propriété	Type	Description
id	Chaîne	Identificateur unique de la ressource. (lecture seule)
displayName	Chaîne	Nom du profil de configuration pour la synchronisation des identités.
dataProvider	educationSynchronizationDataProvider	Fournisseur de données utilisé pour le profil.
expirationDate	Date	Date à laquelle le profil doit être considéré comme expiré et cesser la synchronisation. Indiquez la date au `YYYY-MM-DD` format ISO 8601. La valeur maximale est de 18 mois à compter de la création du profil. (facultatif)
handleSpecialCharacterConstraint	Bool	Détermine si School Data Sync doit remplacer automatiquement les caractères spéciaux non pris en charge lors de la synchronisation à partir de la source.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Détermine la façon dont le profil doit créer de nouveaux utilisateurs ou correspondre aux utilisateurs Microsoft Entra existants.
licensesToAssign	collection educationSynchronizationLicenseAssignment	Configuration de la configuration de la licence.
state	educationSynchronizationProfileState	État du profil. Les valeurs possibles sont les suivantes : `provisioning`, `provisioned`, `provisioningFailed`, `deleting`, `deletionFailed`.

Relations

Relation	Type	Description
erreurs	collection educationSynchronizationError	Toutes les erreurs associées à ce profil de synchronisation.
profileStatus	educationSynchronizationProfileStatus	État de synchronisation.

Fournisseurs de données

Chaque educationSynchronizationProfile doit spécifier l’un des fournisseurs de données suivants à utiliser comme source de synchronisation.

Data Provider	Description
educationCsvDataProvider	Fichiers CSV chargés vers l’URL SAS du profil
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	API PowerSchool

Représentation JSON

Voici une représentation JSON de la ressource educationSynchronizationProfile .

{
  "id": "String",
  "displayName": "String",
  "state": "String",
  "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"
}

Partager via