synchronizationRule

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name	Type	Description
containerFilter	object
editable	boolean	true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
groupFilter	object
id	string	Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API.
metadata	array	Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn't be changed.
name	string	Human-readable name of the synchronization rule. Not nullable.
objectMappings	array	Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.
priority	number	Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.
sourceDirectoryName	string	Name of the source directory. Must match one of the directory definitions in synchronizationSchema.
targetDirectoryName	string	Name of the target directory. Must match one of the directory definitions in synchronizationSchema.
@odata.type	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.synchronizationRule",
  "title": "synchronizationRule",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "containerFilter": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.containerFilter"
        },
        {
          "type": "object",
          "nullable": true
        }
      ]
    },
    "editable": {
      "type": "boolean",
      "description": "true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed."
    },
    "groupFilter": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/microsoft.graph.groupFilter"
        },
        {
          "type": "object",
          "nullable": true
        }
      ]
    },
    "id": {
      "type": "string",
      "description": "Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API.",
      "nullable": true
    },
    "metadata": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.stringKeyStringValuePair"
      },
      "description": "Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn't be changed."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the synchronization rule. Not nullable.",
      "nullable": true
    },
    "objectMappings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/microsoft.graph.objectMapping"
      },
      "description": "Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized."
    },
    "priority": {
      "maximum": 2147483647,
      "minimum": -2147483648,
      "type": "number",
      "description": "Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.",
      "format": "int32"
    },
    "sourceDirectoryName": {
      "type": "string",
      "description": "Name of the source directory. Must match one of the directory definitions in synchronizationSchema.",
      "nullable": true
    },
    "targetDirectoryName": {
      "type": "string",
      "description": "Name of the target directory. Must match one of the directory definitions in synchronizationSchema.",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}