educationSynchronizationProfile リソースの種類 (非推奨)
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
注意
Education Synchronization Profile API は非推奨となり、2024 年 12 月 31 日にデータの返しを停止します。 新しい Industry Data API に移行する方法の詳細については、「 School Data Sync (クラシック)からの移行」を参照してください。
ソース ディレクトリから Microsoft Entra ID に教育エンティティと名簿情報を同期するために使用される一連の構成を表します。 このリソースは、 School Data Sync で使用されるプログラム表現を提供します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| プロファイルの一覧表示 | educationSynchronizationProfile コレクション | テナント内のすべての同期プロファイルの一覧を取得します。 |
| Get profile | educationSynchronizationProfile | プロファイル識別子を指定して特定のプロファイルを取得します。 |
| プロファイルの作成 | educationSynchronizationProfile | 新しい同期プロファイルを作成します。 |
| プロファイルの更新 | educationSynchronizationProfile | テナント内の既存の学校データ 同期プロファイル のプロパティを更新します。 |
| Delete profile | なし | プロファイル識別子を指定して、特定のプロファイルを削除します。 |
| プロファイルを一時停止する | なし | 進行中の同期を一時停止します。 |
| 再開プロファイル | なし | 一時停止した同期を再開します。 |
| プロファイルのリセット | なし | プロファイルの状態をリセットし、同期を再起動します。 |
| CSV プロファイルの開始 | educationFileSynchronizationVerificationMessageコレクション | アップロードされたソース ファイルを確認し、同期を開始します。 データ プロバイダーが educationCsvDataProvider の場合にのみ適用されます。 |
| CSV アップロード URL を取得する | string | CSV データ ファイルをアップロードする有効期間の短い URL を返します。 データ プロバイダーが educationCsvDataProvider の場合にのみ適用されます。 |
| 状態の取得 | educationsynchronizationProfileStatus | 特定の同期プロファイルの状態を返します。 |
| エラーを取得する | educationSynchronizationError コレクション | 同期中に生成されたすべてのエラーを取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| id | String | リソースの一意識別子。 (読み取り専用) |
| displayName | String | ID を同期するための構成プロファイルの名前。 |
| dataProvider | educationSynchronizationDataProvider | プロファイルに使用されるデータ プロバイダー。 |
| expirationDate | Date | プロファイルの有効期限が切れていると見なされ、同期を停止する日付。
ISO 8601 に従って、YYYY-MM-DD形式で日付を指定します。 最大値は、プロファイルの作成から 18 か月です。 (省略可能) |
| handleSpecialCharacterConstraint | ブール | ソースからの同期中に、サポートされていない特殊文字を School Data Sync で自動的に置き換えるかどうかを決定します。 |
| identitySynchronizationConfiguration | educationIdentitySynchronizationConfiguration | プロファイルで 新しい ユーザーを作成するか、既存の Microsoft Entra ユーザー と一致させる 方法を決定します。 |
| 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": "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"
}