New-MgServicePrincipalSynchronizationJob
Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.
Note
To view the beta release of this cmdlet, view New-MgBetaServicePrincipalSynchronizationJob
Syntax
New-MgServicePrincipalSynchronizationJob
-ServicePrincipalId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-BulkUpload <Hashtable>]
[-Id <String>]
[-Schedule <IMicrosoftGraphSynchronizationSchedule>]
[-Schema <IMicrosoftGraphSynchronizationSchema>]
[-Status <IMicrosoftGraphSynchronizationStatus>]
[-SynchronizationJobSettings <IMicrosoftGraphKeyValuePair[]>]
[-TemplateId <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgServicePrincipalSynchronizationJob
-ServicePrincipalId <String>
-BodyParameter <IMicrosoftGraphSynchronizationJob>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgServicePrincipalSynchronizationJob
-InputObject <IApplicationsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-BulkUpload <Hashtable>]
[-Id <String>]
[-Schedule <IMicrosoftGraphSynchronizationSchedule>]
[-Schema <IMicrosoftGraphSynchronizationSchema>]
[-Status <IMicrosoftGraphSynchronizationStatus>]
[-SynchronizationJobSettings <IMicrosoftGraphKeyValuePair[]>]
[-TemplateId <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgServicePrincipalSynchronizationJob
-InputObject <IApplicationsIdentity>
-BodyParameter <IMicrosoftGraphSynchronizationJob>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Synchronization.ReadWrite.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Application.ReadWrite.OwnedBy | Synchronization.ReadWrite.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Applications
$params = @{
templateId = "BoxOutDelta"
}
New-MgServicePrincipalSynchronizationJob -ServicePrincipalId $servicePrincipalId -BodyParameter $paramsThis example shows how to use the New-MgServicePrincipalSynchronizationJob Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
synchronizationJob To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphSynchronizationJob |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BulkUpload
bulkUpload
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IApplicationsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Schedule
synchronizationSchedule To construct, see NOTES section for SCHEDULE properties and create a hash table.
| Type: | IMicrosoftGraphSynchronizationSchedule |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Schema
synchronizationSchema To construct, see NOTES section for SCHEMA properties and create a hash table.
| Type: | IMicrosoftGraphSynchronizationSchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePrincipalId
The unique identifier of servicePrincipal
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
synchronizationStatus To construct, see NOTES section for STATUS properties and create a hash table.
| Type: | IMicrosoftGraphSynchronizationStatus |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SynchronizationJobSettings
Settings associated with the job. Some settings are inherited from the template. To construct, see NOTES section for SYNCHRONIZATIONJOBSETTINGS properties and create a hash table.
| Type: | IMicrosoftGraphKeyValuePair[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateId
Identifier of the synchronization template this job is based on.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IApplicationsIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSynchronizationJob
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSynchronizationJob
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphSynchronizationJob>: synchronizationJob
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[BulkUpload <IMicrosoftGraphBulkUpload>]: bulkUpload[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.
[Schedule <IMicrosoftGraphSynchronizationSchedule>]: synchronizationSchedule[(Any) <Object>]: This indicates any property can be added to this object.[Expiration <DateTime?>]: Date and time when this job expires. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Interval <TimeSpan?>]: The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, P1M represents a period of one month and PT1M represents a period of one minute.[State <String>]: synchronizationScheduleState
[Schema <IMicrosoftGraphSynchronizationSchema>]: synchronizationSchema[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Directories <IMicrosoftGraphDirectoryDefinition-[]>]: Contains the collection of directories and all of their objects.[Id <String>]: The unique identifier for an entity. Read-only.[Discoverabilities <String>]: directoryDefinitionDiscoverabilities[DiscoveryDateTime <DateTime?>]: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Name <String>]: Name of the directory. Must be unique within the synchronization schema. Not nullable.[Objects <IMicrosoftGraphObjectDefinition-[]>]: Collection of objects supported by the directory.[Attributes <IMicrosoftGraphAttributeDefinition-[]>]: Defines attributes of the object.[Anchor <Boolean?>]: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-[]>]:[Key <String>]: Key.[Value <String>]: Value.
[CaseExact <Boolean?>]: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]: The default value of the attribute.[FlowNullValues <Boolean?>]: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: attributeDefinitionMetadata[Value <String>]: Value of the metadata property.
[Multivalued <Boolean?>]: true if an attribute can have multiple values. Default is false.[Mutability <String>]: mutability[Name <String>]: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-[]>]: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]: attributeType
[Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: objectDefinitionMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Name of the object. Must be unique within a directory definition. Not nullable.[SupportedApis <String-[]>]: The API that the provisioning service queries to retrieve data for synchronization.
[ReadOnly <Boolean?>]: Whether this object is read-only.[Version <String>]: Read only value that indicates version discovered. null if discovery hasn't yet occurred.
[SynchronizationRules <IMicrosoftGraphSynchronizationRule-[]>]: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.[ContainerFilter <IMicrosoftGraphContainerFilter>]: containerFilter[(Any) <Object>]: This indicates any property can be added to this object.[IncludedContainers <String-[]>]:
[Editable <Boolean?>]: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.[GroupFilter <IMicrosoftGraphGroupFilter>]: groupFilter[(Any) <Object>]: This indicates any property can be added to this object.[IncludedGroups <String-[]>]:
[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 <IMicrosoftGraphStringKeyStringValuePair-[]>]: 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 <IMicrosoftGraphObjectMapping-[]>]: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.[AttributeMappings <IMicrosoftGraphAttributeMapping-[]>]: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values.[DefaultValue <String>]: Default value to be used in case the source property was evaluated to null. Optional.[ExportMissingReferences <Boolean?>]: For internal use only.[FlowBehavior <String>]: attributeFlowBehavior[FlowType <String>]: attributeFlowType[MatchingPriority <Int32?>]: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes.[Source <IMicrosoftGraphAttributeMappingSource>]: attributeMappingSource[(Any) <Object>]: This indicates any property can be added to this object.[Expression <String>]: Equivalent expression representation of this attributeMappingSource object.[Name <String>]: Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.[Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-[]>]: If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn't Function, this property is null/empty array.[Key <String>]: The name of the parameter.[Value <IMicrosoftGraphAttributeMappingSource>]: attributeMappingSource
[Type <String>]: attributeMappingSourceType
[TargetAttributeName <String>]: Name of the attribute on the target object.
[Enabled <Boolean?>]: When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped.[FlowTypes <String>]: objectFlowTypes[Metadata <IMicrosoftGraphObjectMappingMetadataEntry-[]>]: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.[Key <String>]: objectMappingMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Human-friendly name of the object mapping.[Scope <IMicrosoftGraphFilter>]: filter[(Any) <Object>]: This indicates any property can be added to this object.[CategoryFilterGroups <IMicrosoftGraphFilterGroup-[]>]: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[Clauses <IMicrosoftGraphFilterClause-[]>]: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true.[OperatorName <String>]: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered.[SourceOperandName <String>]: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object.[TargetOperand <IMicrosoftGraphFilterOperand>]: filterOperand[(Any) <Object>]: This indicates any property can be added to this object.[Values <String-[]>]: Collection of values.
[Name <String>]: Human-readable name of the filter group.
[Groups <IMicrosoftGraphFilterGroup-[]>]: Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get deprovisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[InputFilterGroups <IMicrosoftGraphFilterGroup-[]>]: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get deprovisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true.
[SourceObjectName <String>]: Name of the object in the source directory. Must match the object name from the source directory definition.[TargetObjectName <String>]: Name of the object in target directory. Must match the object name from the target directory definition.
[Priority <Int32?>]: 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.
[Version <String>]: The version of the schema, updated automatically with every schema change.
[Status <IMicrosoftGraphSynchronizationStatus>]: synchronizationStatus[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: synchronizationStatusCode[CountSuccessiveCompleteFailures <Int64?>]: Number of consecutive times this job failed.[EscrowsPruned <Boolean?>]: true if the job's escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job's errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.[LastExecution <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[(Any) <Object>]: This indicates any property can be added to this object.[ActivityIdentifier <String>]: Identifier of the job run.[CountEntitled <Int64?>]: Count of processed entries that were assigned for this application.[CountEntitledForProvisioning <Int64?>]: Count of processed entries that were assigned for provisioning.[CountEscrowed <Int64?>]: Count of entries that were escrowed (errors).[CountEscrowedRaw <Int64?>]: Count of entries that were escrowed, including system-generated escrows.[CountExported <Int64?>]: Count of exported entries.[CountExports <Int64?>]: Count of entries that were expected to be exported.[CountImported <Int64?>]: Count of imported entries.[CountImportedDeltas <Int64?>]: Count of imported delta-changes.[CountImportedReferenceDeltas <Int64?>]: Count of imported delta-changes pertaining to reference changes.[Error <IMicrosoftGraphSynchronizationError>]: synchronizationError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure.[Message <String>]: The error message. For example, Policy permitting auto-redemption of invitations not configured.[TenantActionable <Boolean?>]: The action to take to resolve the error. For example, false.
[State <String>]: synchronizationTaskExecutionResult[TimeBegan <DateTime?>]: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[TimeEnded <DateTime?>]: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[Progress <IMicrosoftGraphSynchronizationProgress-[]>]: Details of the progress of a job toward completion.[CompletedUnits <Int64?>]: The numerator of a progress ratio; the number of units of changes already processed.[ProgressObservationDateTime <DateTime?>]: The time of a progress observation as an offset in minutes from UTC.[TotalUnits <Int64?>]: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.[Units <String>]: An optional description of the units.
[Quarantine <IMicrosoftGraphSynchronizationQuarantine>]: synchronizationQuarantine[(Any) <Object>]: This indicates any property can be added to this object.[CurrentBegan <DateTime?>]: Date and time when the quarantine was last evaluated and imposed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Error <IMicrosoftGraphSynchronizationError>]: synchronizationError[NextAttempt <DateTime?>]: Date and time when the next attempt to re-evaluate the quarantine will be made. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Reason <String>]: quarantineReason[SeriesBegan <DateTime?>]: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted). The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SeriesCount <Int64?>]: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
[SteadyStateFirstAchievedTime <DateTime?>]: The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SteadyStateLastAchievedTime <DateTime?>]: The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-[]>]: Count of synchronized objects, listed by object type.[Key <String>]: The mapping of the user type from the source system to the target system. For example:User to User - For Microsoft Entra ID to Microsoft Entra ID synchronization worker to user - For Workday to Microsoft Entra synchronization.[Value <Int64?>]: Total number of synchronized objects.
[TroubleshootingUrl <String>]: In the event of an error, the URL with the troubleshooting steps for the issue.
[SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-[]>]: Settings associated with the job. Some settings are inherited from the template.[Name <String>]: Name for this key-value pair[Value <String>]: Value for this key-value pair
[TemplateId <String>]: Identifier of the synchronization template this job is based on.
INPUTOBJECT <IApplicationsIdentity>: Identity Parameter
[AppId <String>]: Alternate key of application[AppManagementPolicyId <String>]: The unique identifier of appManagementPolicy[AppRoleAssignmentId <String>]: The unique identifier of appRoleAssignment[ApplicationId <String>]: The unique identifier of application[ApplicationTemplateId <String>]: The unique identifier of applicationTemplate[ClaimsMappingPolicyId <String>]: The unique identifier of claimsMappingPolicy[DelegatedPermissionClassificationId <String>]: The unique identifier of delegatedPermissionClassification[DirectoryDefinitionId <String>]: The unique identifier of directoryDefinition[DirectoryObjectId <String>]: The unique identifier of directoryObject[EndpointId <String>]: The unique identifier of endpoint[ExtensionPropertyId <String>]: The unique identifier of extensionProperty[FederatedIdentityCredentialId <String>]: The unique identifier of federatedIdentityCredential[GroupId <String>]: The unique identifier of group[HomeRealmDiscoveryPolicyId <String>]: The unique identifier of homeRealmDiscoveryPolicy[Name <String>]: Alternate key of federatedIdentityCredential[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant[ServicePrincipalId <String>]: The unique identifier of servicePrincipal[SynchronizationJobId <String>]: The unique identifier of synchronizationJob[SynchronizationTemplateId <String>]: The unique identifier of synchronizationTemplate[TargetDeviceGroupId <String>]: The unique identifier of targetDeviceGroup[TokenIssuancePolicyId <String>]: The unique identifier of tokenIssuancePolicy[TokenLifetimePolicyId <String>]: The unique identifier of tokenLifetimePolicy[UniqueName <String>]: Alternate key of application[UserId <String>]: The unique identifier of user
SCHEDULE <IMicrosoftGraphSynchronizationSchedule>: synchronizationSchedule
[(Any) <Object>]: This indicates any property can be added to this object.[Expiration <DateTime?>]: Date and time when this job expires. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Interval <TimeSpan?>]: The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, P1M represents a period of one month and PT1M represents a period of one minute.[State <String>]: synchronizationScheduleState
SCHEMA <IMicrosoftGraphSynchronizationSchema>: synchronizationSchema
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Directories <IMicrosoftGraphDirectoryDefinition-[]>]: Contains the collection of directories and all of their objects.[Id <String>]: The unique identifier for an entity. Read-only.[Discoverabilities <String>]: directoryDefinitionDiscoverabilities[DiscoveryDateTime <DateTime?>]: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Name <String>]: Name of the directory. Must be unique within the synchronization schema. Not nullable.[Objects <IMicrosoftGraphObjectDefinition-[]>]: Collection of objects supported by the directory.[Attributes <IMicrosoftGraphAttributeDefinition-[]>]: Defines attributes of the object.[Anchor <Boolean?>]: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-[]>]:[Key <String>]: Key.[Value <String>]: Value.
[CaseExact <Boolean?>]: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]: The default value of the attribute.[FlowNullValues <Boolean?>]: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: attributeDefinitionMetadata[Value <String>]: Value of the metadata property.
[Multivalued <Boolean?>]: true if an attribute can have multiple values. Default is false.[Mutability <String>]: mutability[Name <String>]: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-[]>]: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]: attributeType
[Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: objectDefinitionMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Name of the object. Must be unique within a directory definition. Not nullable.[SupportedApis <String-[]>]: The API that the provisioning service queries to retrieve data for synchronization.
[ReadOnly <Boolean?>]: Whether this object is read-only.[Version <String>]: Read only value that indicates version discovered. null if discovery hasn't yet occurred.
[SynchronizationRules <IMicrosoftGraphSynchronizationRule-[]>]: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.[ContainerFilter <IMicrosoftGraphContainerFilter>]: containerFilter[(Any) <Object>]: This indicates any property can be added to this object.[IncludedContainers <String-[]>]:
[Editable <Boolean?>]: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.[GroupFilter <IMicrosoftGraphGroupFilter>]: groupFilter[(Any) <Object>]: This indicates any property can be added to this object.[IncludedGroups <String-[]>]:
[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 <IMicrosoftGraphStringKeyStringValuePair-[]>]: 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 <IMicrosoftGraphObjectMapping-[]>]: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.[AttributeMappings <IMicrosoftGraphAttributeMapping-[]>]: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values.[DefaultValue <String>]: Default value to be used in case the source property was evaluated to null. Optional.[ExportMissingReferences <Boolean?>]: For internal use only.[FlowBehavior <String>]: attributeFlowBehavior[FlowType <String>]: attributeFlowType[MatchingPriority <Int32?>]: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes.[Source <IMicrosoftGraphAttributeMappingSource>]: attributeMappingSource[(Any) <Object>]: This indicates any property can be added to this object.[Expression <String>]: Equivalent expression representation of this attributeMappingSource object.[Name <String>]: Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.[Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-[]>]: If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn't Function, this property is null/empty array.[Key <String>]: The name of the parameter.[Value <IMicrosoftGraphAttributeMappingSource>]: attributeMappingSource
[Type <String>]: attributeMappingSourceType
[TargetAttributeName <String>]: Name of the attribute on the target object.
[Enabled <Boolean?>]: When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped.[FlowTypes <String>]: objectFlowTypes[Metadata <IMicrosoftGraphObjectMappingMetadataEntry-[]>]: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.[Key <String>]: objectMappingMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Human-friendly name of the object mapping.[Scope <IMicrosoftGraphFilter>]: filter[(Any) <Object>]: This indicates any property can be added to this object.[CategoryFilterGroups <IMicrosoftGraphFilterGroup-[]>]: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[Clauses <IMicrosoftGraphFilterClause-[]>]: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true.[OperatorName <String>]: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered.[SourceOperandName <String>]: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object.[TargetOperand <IMicrosoftGraphFilterOperand>]: filterOperand[(Any) <Object>]: This indicates any property can be added to this object.[Values <String-[]>]: Collection of values.
[Name <String>]: Human-readable name of the filter group.
[Groups <IMicrosoftGraphFilterGroup-[]>]: Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get deprovisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[InputFilterGroups <IMicrosoftGraphFilterGroup-[]>]: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, then it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get deprovisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true.
[SourceObjectName <String>]: Name of the object in the source directory. Must match the object name from the source directory definition.[TargetObjectName <String>]: Name of the object in target directory. Must match the object name from the target directory definition.
[Priority <Int32?>]: 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.
[Version <String>]: The version of the schema, updated automatically with every schema change.
STATUS <IMicrosoftGraphSynchronizationStatus>: synchronizationStatus
[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: synchronizationStatusCode[CountSuccessiveCompleteFailures <Int64?>]: Number of consecutive times this job failed.[EscrowsPruned <Boolean?>]: true if the job's escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job's errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.[LastExecution <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[(Any) <Object>]: This indicates any property can be added to this object.[ActivityIdentifier <String>]: Identifier of the job run.[CountEntitled <Int64?>]: Count of processed entries that were assigned for this application.[CountEntitledForProvisioning <Int64?>]: Count of processed entries that were assigned for provisioning.[CountEscrowed <Int64?>]: Count of entries that were escrowed (errors).[CountEscrowedRaw <Int64?>]: Count of entries that were escrowed, including system-generated escrows.[CountExported <Int64?>]: Count of exported entries.[CountExports <Int64?>]: Count of entries that were expected to be exported.[CountImported <Int64?>]: Count of imported entries.[CountImportedDeltas <Int64?>]: Count of imported delta-changes.[CountImportedReferenceDeltas <Int64?>]: Count of imported delta-changes pertaining to reference changes.[Error <IMicrosoftGraphSynchronizationError>]: synchronizationError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure.[Message <String>]: The error message. For example, Policy permitting auto-redemption of invitations not configured.[TenantActionable <Boolean?>]: The action to take to resolve the error. For example, false.
[State <String>]: synchronizationTaskExecutionResult[TimeBegan <DateTime?>]: Time when this job run began. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[TimeEnded <DateTime?>]: Time when this job run ended. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]: synchronizationTaskExecution[Progress <IMicrosoftGraphSynchronizationProgress-[]>]: Details of the progress of a job toward completion.[CompletedUnits <Int64?>]: The numerator of a progress ratio; the number of units of changes already processed.[ProgressObservationDateTime <DateTime?>]: The time of a progress observation as an offset in minutes from UTC.[TotalUnits <Int64?>]: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.[Units <String>]: An optional description of the units.
[Quarantine <IMicrosoftGraphSynchronizationQuarantine>]: synchronizationQuarantine[(Any) <Object>]: This indicates any property can be added to this object.[CurrentBegan <DateTime?>]: Date and time when the quarantine was last evaluated and imposed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Error <IMicrosoftGraphSynchronizationError>]: synchronizationError[NextAttempt <DateTime?>]: Date and time when the next attempt to re-evaluate the quarantine will be made. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Reason <String>]: quarantineReason[SeriesBegan <DateTime?>]: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted). The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SeriesCount <Int64?>]: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
[SteadyStateFirstAchievedTime <DateTime?>]: The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SteadyStateLastAchievedTime <DateTime?>]: The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-[]>]: Count of synchronized objects, listed by object type.[Key <String>]: The mapping of the user type from the source system to the target system. For example:User to User - For Microsoft Entra ID to Microsoft Entra ID synchronization worker to user - For Workday to Microsoft Entra synchronization.[Value <Int64?>]: Total number of synchronized objects.
[TroubleshootingUrl <String>]: In the event of an error, the URL with the troubleshooting steps for the issue.
SYNCHRONIZATIONJOBSETTINGS <IMicrosoftGraphKeyValuePair- []>: Settings associated with the job.
Some settings are inherited from the template.
[Name <String>]: Name for this key-value pair[Value <String>]: Value for this key-value pair
RELATED LINKS
https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0