Namespace: microsoft.graph
Provides preconfigured synchronization settings for a particular application. These settings are used by default for any synchronization job that is based on the template. The application developer specifies the template; anyone can retrieve the template to see the default settings, including the synchronization schema.
You can provide multiple templates for an application, and designate a default template. If multiple templates are available for the application you're interested in, seek application-specific guidance to determine which one best meets your needs.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | synchronizationTemplate collection | List the templates that are available for an application or application instance (service principal). |
| Get | synchronizationTemplate | Read the properties and relationships of the synchronizationTemplate object. |
| Update | synchronizationTemplate | Update the properties and relationships of the synchronizationTemplate object. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Unique template identifier. |
| applicationId | String | Identifier of the application this template belongs to. |
| default | Boolean | true if this template is recommended to be the default for the application. |
| description | String | Description of the template. |
| discoverable | String | true if this template should appear in the collection of templates available for the application instance (service principal). |
| factoryTag | String | One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template. |
| metadata | synchronizationMetadataEntry collection | Additional extension properties. Unless mentioned explicitly, metadata values should not be changed. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| schema | synchronizationSchema | Default synchronization schema for the jobs based on this template. |
JSON representation
The following JSON representation shows the resource type.
{
"applicationId": "String (identifier)",
"default": true,
"description": "String",
"discoverable": true,
"factoryTag": "String",
"id": "String (identifier)",
"metadata": [
{
"@odata.type": "microsoft.graph.synchronizationMetadataEntry"
}
],
"schema": {
"@odata.type": "microsoft.graph.synchronizationSchema"
}
}