synchronizationSchema resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Defines what objects are synchronized and how they are synchronized. The synchronization schema contains most of the setup information for a particular synchronization job. Typically, you customize some of the attribute mappings, or add a scoping filter to synchronize only objects that satisfy a certain condition.
The following sections describe the high-level components of the synchronization schema.
Directory definitions
Directory definitions provide the synchronization engine information about directories and their objects. For example, the directory definition tells the synchronization engine that a Microsoft Entra directory has objects named user and group, which attributes are supported for those objects, and the types for those attributes. In order for a particular object and attribute to be used in synchronization rules/object mappings, they have to be defined as part of the directory definition.
Synchronization rules
Synchronization rules are the core of the synchronization setup. They define for the synchronization engine how the synchronization should be performed, including what objects should be synchronized, how objects from the source directory should be matched with objects in the target directory, and how attributes should be transformed when they're synchronized from the source to the target directory.
Object mappings
Object mappings are the main part of the synchronization rule. Each object mapping defines how a given object should be synchronized from the source to the target directory. In particular, the mapping defines how an object in the source directory should be matched with an object in the target directory, what (if any) scoping filters should be used to decide whether to provision an object, and how object attributes should be transformed when they're synchronized from the source to the target directory.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get | synchronizationSchema | Read properties and relationships of the synchronizationSchema object. |
| Update | None | Update the synchronization schema. |
| Reset | None | Delete the customized schema, resetting the schema to the default configuration. |
| Get schema filter operators | filterOperatorSchema collection | List all operators supported in the scoping filters. |
| Get schema functions | attributeMappingFunctionSchema collection | List all functions supported in the attribute mapping expressions. |
| Parse attribute mapping expression | parseExpressionResponse | Parse a string expression into an attributeMappingSource object. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier for the schema. |
| synchronizationRules | synchronizationRule collection | A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate. |
| version | String | The version of the schema, updated automatically with every schema change. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| directories | directoryDefinition collection | Contains the collection of directories and all of their objects. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.synchronizationSchema",
"id": "String (identifier)",
"synchronizationRules": [
{
"@odata.type": "microsoft.graph.synchronizationRule"
}
],
"version": "String"
}