synchronizationJob 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

通过定期在后台运行、轮询一个目录中的更改,以及将它们推送到另一个目录执行同步。 同步作业始终特定于租户中应用程序的特定实例。 作为同步作业设置的一部分,您需要授权读取和写入目标目录中的对象,并自定义作业的同步架构。

方法

方法 返回类型 Description
List synchronizationJob 集合 列出给定应用程序实例的现有作业 (服务主体) 。
获取 synchronizationJob synchronizationJob 读取 synchronizationJob 对象的属性和关系。
创建 synchronizationJob 为给定应用程序创建新作业。
开始 启动同步。 如果作业已暂停,则从作业暂停时开始继续。 如果作业被隔离,则清除隔离状态。
Restart 强制作业重新开始并重新处理目录中的所有对象。
Pause 暂时停止同步。 所有进度(包括作业状态)都将保持,并且作业将在启动调用时从它离开的地方继续。
删除 停止同步,并永久删除与作业关联的所有状态。
获取 synchronizationSchema synchronizationSchema 检索作业的有效同步架构。
更新 synchronizationSchema 更新作业的同步架构。
验证凭据 针对目标目录测试提供的凭据。
provisionOnDemand synchronizationJobApplicationParameters 集合 表示将设置的对象和执行同步规则。 资源主要用于按需预配。

属性

属性 类型 说明
id 字符串 唯一同步作业标识符。 只读。
schedule synchronizationSchedule 用于运行作业的计划。 只读。
status synchronizationStatus 作业的状态,包括上次运行作业时、当前作业状态和错误。
synchronizationJobSettings keyValuePair 与作业关联的设置。 某些设置是从模板继承的。
templateId 字符串 此作业 所基于的 同步模板的标识符。

关系

关系 类型 说明
架构 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"
}