Skip to content

synchronization-synchronizationjob.md

Latest commit

 

History

History
89 lines (73 loc) · 4.79 KB

synchronization-synchronizationjob.md

File metadata and controls

89 lines (73 loc) · 4.79 KB
title synchronizationJob resource type
description Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
ms.localizationpriority medium
doc_type resourcePageType
author ArvindHarinder1
ms.subservice entra-applications
ms.date 07/22/2024

synchronizationJob resource type

Namespace: microsoft.graph

Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory. The synchronization job is always specific to a particular instance of an application in your tenant. As part of the synchronization job setup, you need to give authorization to read and write objects in your target directory, and customize the job's synchronization schema.

Methods

Method Return Type Description
List synchronizationJob collection List existing jobs for a given application instance (service principal).
Get synchronizationJob Read properties and relationships of a synchronizationJob object.
Create synchronizationJob Create new job for a given application.
Start None Start synchronization. If the job is in a paused state, it continues from the point where the job was paused. If the job is in quarantine, the quarantine status is cleared.
Pause None Temporarily stop synchronization. All the progress, including job state, is persisted, and the job will continue from where it left off when a Start call is made.
Restart None Force the job to start over and re-process all the objects in the directory.
Delete None Stop synchronization, and permanently delete all the state associated with the job.
Provision on demand synchronizationJobApplicationParameters collection Represents the objects that will be provisioned and the synchronization rules executed. The resource is primarily used for on-demand provisioning.
Validate credentials None Test provided credentials against target directory.

Properties

Property Type Description
id String Unique synchronization job identifier. Read-only.
schedule synchronizationSchedule Schedule used to run the job. Read-only.
status synchronizationStatus Status of the job, which includes when the job was last run, current job state, and errors.
synchronizationJobSettings keyValuePair Settings associated with the job. Some settings are inherited from the template.
templateId String Identifier of the synchronization template this job is based on.

Relationships

Relationship Type Description
bulkUpload bulkUpload The bulk upload operation for the job.
schema synchronizationSchema The synchronization schema configured for the job.

JSON representation

The following JSON representation shows the resource type.

{
  "id": "String (identifier)",
  "schedule": {
    "@odata.type": "microsoft.graph.synchronizationSchedule"
  },
  "status": {
    "@odata.type": "microsoft.graph.synchronizationStatus"
  },
  "synchronizationJobSettings": {
    "@odata.type": "microsoft.graph.keyValuePair"
  },
  "templateId": "String"
}