educationSynchronizationProfile リソースの種類

[アーティクル]
03/08/2022

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

教育エンティティと名簿情報をソースディレクトリからソースディレクトリ (Azure AD) に同期するために使用される構成のセットを表Azure Active Directory。このリソースは、このリソースで使用されるプログラムによる学校データ同期。

メソッド

メソッド	戻り値の型	説明
リストプロファイル	educationSynchronizationProfile コレクション	テナント内のすべての同期プロファイルの一覧を取得します。
プロファイルを取得する	educationSynchronizationProfile	プロファイル識別子を指定して特定のプロファイルを取得します。
プロファイルの作成	なし	新しい同期プロファイルを作成します。
プロファイルを削除する	educationSynchronizationProfile	プロファイル識別子を指定して、特定のプロファイルを削除します。
プロファイルの一時停止	なし	継続的な同期を一時停止します。
プロファイルの再開	なし	一時停止中の同期を再開します。
プロファイルのリセット	なし	プロファイルの状態をリセットし、同期を再開します。
CSV プロファイルの開始	[educationFileSynchronizationVerificationMessagecollection]	アップロードされたソースファイルを確認し、同期を開始します。データプロバイダーが [educationCsvDataProvider の場合にのみ適用されます]。
CSV アップロード URL の取得	string	短命の URL を返して CSV データファイルをアップロードします。データプロバイダーが [educationCsvDataProvider の場合にのみ適用されます]。
状態の取得	educationsynchronizationProfileStatus	特定の同期プロファイルの状態を返します。
エラーの取得	educationSynchronizationError コレクション	同期中に生成されたエラーをすべて取得します。

プロパティ

プロパティ	型	説明
id	String	リソースの一意識別子。 (読み取り専用)
displayName	String	ID を同期する構成プロファイルの名前。
dataProvider	educationSynchronizationDataProvider	プロファイルに使用されるデータプロバイダー。
expirationDate	日付	プロファイルが期限切れと見なされ、同期を停止する日付。 `YYYY-MM-DD` ISO 8601 に従って、日付の形式を指定します。最大値は、プロファイルの作成から 18 か月です。 (省略可能)
handleSpecialCharacterConstraint	ブール	ソースから同期学校データ同期、サポートされていない特殊文字を自動的に置き換えるかどうかを決定します。
identitySynchronizationConfiguration	educationIdentitySynchronizationConfiguration	プロファイルで既存のユーザーを新しく作成するか、既存のユーザーと一致AADします。
licensesToAssign	educationSynchronizationLicenseAssignment コレクション	ライセンスセットアップの構成。
state	educationSynchronizationProfileState	プロファイルの状態。可能な値は、`provisioning`、`provisioned`、`provisioningFailed`、`deleting`、`deletionFailed` です。

リレーションシップ

リレーションシップ	型	説明
エラー	educationSynchronizationError コレクション	この同期プロファイルに関連付けられているすべてのエラー。
profileStatus	educationSynchronizationProfileStatus	同期の状態。

データプロバイダー

EducationSynchronizationProfile ごとに、同期ソースとして使用するフォローデータプロバイダーのいずれかを指定する必要があります。

Data Provider	説明
educationCsvDataProvider	プロファイルの SAS URL にアップロードされた CSV ファイル
educationOneRosterApiDataProvider	OneRoster v1.1 API
educationPowerSchoolDataProvider	PowerSchool API

JSON 表記

educationSynchronizationProfile リソースの JSON 表記を次に示 します。

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