synchronizationSchema 资源类型

命名空间：microsoft.graph

重要

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

定义要同步的对象及其同步方式。 同步架构包含特定同步作业的大部分设置信息。 通常，可以自定义某些 属性映射，或添加 范围筛选器 ，以便仅同步满足特定条件的对象。

以下部分介绍同步架构的高级组件。

目录定义

目录定义 提供有关目录及其对象的同步引擎信息。 例如，目录定义告知同步引擎Microsoft Entra目录具有名为 user 和 group 的对象、这些对象支持哪些属性以及这些属性的类型。 若要在同步规则/对象映射中使用特定对象和属性，必须将它们定义为目录定义的一部分。

同步规则

同步规则 是同步设置的核心。 它们为同步引擎定义应如何执行同步，包括应同步哪些对象、源目录中的对象应如何与目标目录中的对象匹配，以及属性从源目录同步到目标目录时应如何转换。

对象映射

对象映射是同步规则main部分。 每个对象映射定义如何将给定对象从源同步到目标目录。 具体而言，映射定义了应如何将源目录中的对象与目标目录中的对象进行匹配， (如果应使用任何) 范围筛选器来决定是否预配对象，以及对象属性从源目录同步到目标目录时应如何转换这些属性。

方法

方法	返回类型	说明
获取架构	synchronizationSchema	读取 synchronizationSchema 对象的属性和关系。
更新架构	无	更新同步架构。
删除架构	无	删除自定义架构，将架构重置为默认配置。
列表筛选器运算符	filterOperatorSchema 集合	列出范围筛选器中支持的所有运算符。
列表属性映射函数	attributeMappingFunctionSchema 集合	列出属性映射表达式中支持的所有函数。
分析属性映射表达式	parseExpressionResponse	将字符串表达式分析为 attributeMappingSource 对象。

属性

属性	类型	说明
id	String	架构的唯一标识符。
synchronizationRules	synchronizationRule 集合	为 synchronizationJob 或 synchronizationTemplate 配置的同步规则集合。
version	String	架构的版本，每次架构更改都会自动更新。

关系

关系	类型	说明
目录	directoryDefinition 集合	包含目录及其所有对象的集合。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@odata.type": "#microsoft.graph.synchronizationSchema",
  "id": "String (identifier)",
  "synchronizationRules": [
    {
      "@odata.type": "microsoft.graph.synchronizationRule"
    }
  ],
  "version": "String"
}