Тип ресурса educationSynchronizationProfile (не рекомендуется)

Статья
07/23/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Предостережение

API профиля синхронизации образования не рекомендуется использовать и перестанет возвращать данные 31 декабря 2024 г. Сведения о том, как перейти на новый API отраслевых данных, см. в разделе Переход с синхронизации данных школы (классическая модель).

Представляет набор конфигураций, используемых для синхронизации сущностей образования и сведений о реестре из исходного каталога с идентификатором Microsoft Entra. Этот ресурс предоставляет программное представление, используемое в School Data Sync.

Методы

Метод	Возвращаемый тип	Описание
Список профилей	коллекция educationSynchronizationProfile	Получите список всех профилей синхронизации в клиенте.
Получение профиля	educationSynchronizationProfile	Получение определенного профиля с учетом идентификатора профиля.
Создание профиля	educationSynchronizationProfile	Создайте новый профиль синхронизации.
Обновление профиля	educationSynchronizationProfile	Обновление свойств существующего профиля синхронизации данных учебного заведения в клиенте.
Удаление профиля	Нет	Удалите определенный профиль с учетом идентификатора профиля.
Приостановка профиля	Нет	Приостановка текущей синхронизации.
Профиль возобновления	Нет	Возобновление приостановленной синхронизации.
Сброс профиля	Нет	Сброс состояния профиля и перезапуск синхронизации.
Запуск профиля CSV	коллекция educationFileSynchronizationVerificationMessage	Проверьте отправленные исходные файлы и запустите синхронизацию. Применяется, только если поставщик данных — educationCsvDataProvider.
Получение URL-адреса отправки CSV-файла	string	Возвращает короткий URL-адрес для отправки CSV-файлов данных. Применяется, только если поставщик данных — educationCsvDataProvider.
Получение состояния	educationsynchronizationProfileStatus	Возвращает состояние определенного профиля синхронизации.
Получение ошибок	коллекция educationSynchronizationError	Получение всех ошибок, созданных во время синхронизации.

Свойства

Свойство	Тип	Описание
id	String	Уникальный идентификатор ресурса. (только для чтения)
displayName	String	Имя профиля конфигурации для синхронизации удостоверений.
dataProvider	educationSynchronizationDataProvider	Поставщик данных, используемый для профиля.
expirationDate	Date	Дата окончания срока действия профиля и прекращения синхронизации. Укажите дату в `YYYY-MM-DD` формате iso 8601. Максимальное значение — 18 месяцев с момента создания профиля. (необязательный)
handleSpecialCharacterConstraint	Логический	Определяет, следует ли автоматически заменять неподдерживаемые специальные символы при синхронизации из источника.
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	Определяет, как профиль должен создавать новые или соответствовать существующим пользователям Microsoft Entra.
licenseToAssign	коллекция educationSynchronizationLicenseAssignment	Настройка лицензии.
state	educationSynchronizationProfileState	Состояние профиля. Возможные значения: `provisioning`, `provisioned`, `provisioningFailed`, `deleting`, `deletionFailed`.

Связи

Связь	Тип	Описание
ошибки	коллекция educationSynchronizationError	Все ошибки, связанные с этим профилем синхронизации.
profileStatus	educationSynchronizationProfileStatus	Состояние синхронизации.

Data Providers

Каждый educationSynchronizationProfile должен указать один из следующих поставщиков данных для использования в качестве источника синхронизации.

Поставщик данных	Описание
educationCsvDataProvider	CSV-файлы, отправленные на URL-адрес SAS профиля
educationOneRosterApiDataProvider	API OneRoster версии 1.1
educationPowerSchoolDataProvider	API PowerSchool

Представление JSON

Ниже представлено представление ресурса educationSynchronizationProfile в формате JSON.

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

Поделиться через