educationSynchronizationProfile 资源类型 (已弃用)
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
警告
教育同步配置文件 API 已弃用，将于 2024 年 12 月 31 日停止返回数据。 有关如何迁移到新的行业数据 API 的信息，请参阅 从学校数据同步 (经典) 转换 。
表示一组配置，用于将教育实体和名单信息从源目录同步到Microsoft Entra ID。 此资源提供 学校数据同步中使用的编程表示形式。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 列出配置文件 | educationSynchronizationProfile 集合 | 获取租户中所有同步配置文件的列表。 |
| 获取个人资料 | educationSynchronizationProfile | 在给定配置文件标识符的情况下检索特定配置文件。 |
| 创建配置文件 | educationSynchronizationProfile | 创建新的同步配置文件。 |
| 更新配置文件 | educationSynchronizationProfile | 更新租户中现有学校数据 同步配置文件 的属性。 |
| 删除个人资料 | 无 | 删除给定配置文件标识符的特定配置文件。 |
| 暂停配置文件 | None | 暂停正在进行的同步。 |
| 恢复配置文件 | None | 恢复暂停的同步。 |
| 重置配置文件 | None | 重置配置文件的状态并重启同步。 |
| 启动 CSV 配置文件 | educationFileSynchronizationVerificationMessage集合 | 验证上传的源文件并开始同步。 仅当数据提供程序为 educationCsvDataProvider 时适用。 |
| 获取 CSV 上传 URL | string | 返回用于上传 CSV 数据文件的短期 URL。 仅当数据提供程序为 educationCsvDataProvider 时适用。 |
| 获取状态 | educationsynchronizationProfileStatus | 返回特定同步配置文件的状态。 |
| 获取错误 | educationSynchronizationError 集合 | 获取同步期间生成的所有错误。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| id | String | 资源的唯一标识符。 (只读) |
| displayName | String | 用于同步标识的配置文件的名称。 |
| dataProvider | educationSynchronizationDataProvider | 用于配置文件的数据提供程序。 |
| expirationDate | 日期 | 应将配置文件视为过期和停止同步的日期。 按照 ISO 8601 提供格式的日期YYYY-MM-DD。 最大值为创建配置文件后 18 个月。 （可选） |
| handleSpecialCharacterConstraint | Bool | 确定从源同步时，学校数据同步是否应自动替换不支持的特殊字符。 |
| 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"
}