synchronizationJob 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
通过定期在后台运行、轮询一个目录中的更改并将更改推送到另一个目录来执行同步。 同步作业始终特定于租户中应用程序的特定实例。 在同步作业设置过程中，需要授予读取和写入目标目录中对象的授权，并自定义作业的同步架构。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | synchronizationJob 集合 | 列出给定应用程序实例 (服务主体) 的现有作业。 |
| Get | synchronizationJob | 读取 synchronizationJob 对象的属性和关系。 |
| 创建 | synchronizationJob | 为给定的应用程序创建新作业。 |
| Start | None | 开始同步。 如果作业处于暂停状态，则从作业暂停的点继续运行。 如果作业处于隔离状态，则会清除隔离状态。 |
| Pause | None | 暂时停止同步。 将保留所有进度（包括作业状态），并且作业将从 开始调用时 中断的位置继续。 |
| Restart | None | 强制作业重新启动并重新处理目录中的所有对象。 |
| 删除 | None | 停止同步，并永久删除与作业关联的所有状态。 |
| 按需预配 | synchronizationJobApplicationParameters 集合 | 表示将预配的对象和执行的同步规则。 资源主要用于按需预配。 |
| 验证凭据 | None | 针对目标目录测试提供的凭据。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| id | String | 唯一的同步作业标识符。 此为只读属性。 |
| schedule | synchronizationSchedule | 用于运行作业的计划。 此为只读属性。 |
| status | synchronizationStatus | 作业的状态，包括作业上次运行时间、当前作业状态和错误。 |
| synchronizationJobSettings | keyValuePair | 与作业关联的设置。 某些设置继承自模板。 |
| templateId | String | 此作业所基于的 同步模板 的标识符。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| bulkUpload | bulkUpload | 作业的批量上传操作。 |
| 图式 | synchronizationSchema | 为作业配置的同步架构。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"id": "String (identifier)",
"schedule": {
"@odata.type": "microsoft.graph.synchronizationSchedule"
},
"status": {
"@odata.type": "microsoft.graph.synchronizationStatus"
},
"synchronizationJobSettings": {
"@odata.type": "microsoft.graph.keyValuePair"
},
"templateId": "String"
}