Restart-MgServicePrincipalSynchronizationJob

Module:

Microsoft.Graph.Applications

Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.

Note

To view the beta release of this cmdlet, view Restart-MgBetaServicePrincipalSynchronizationJob

Syntax

Restart-MgServicePrincipalSynchronizationJob
       -ServicePrincipalId <String>
       -SynchronizationJobId <String>
       [-ResponseHeadersVariable <String>]
       [-AdditionalProperties <Hashtable>]
       [-Criteria <IMicrosoftGraphSynchronizationJobRestartCriteria>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restart-MgServicePrincipalSynchronizationJob
       -ServicePrincipalId <String>
       -SynchronizationJobId <String>
       -BodyParameter <IPaths7MrbavServiceprincipalsServiceprincipalIdSynchronizationJobsSynchronizationjobIdMicrosoftGraphRestartPostRequestbodyContentApplicationJsonSchema>
       [-ResponseHeadersVariable <String>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restart-MgServicePrincipalSynchronizationJob
       -InputObject <IApplicationsIdentity>
       [-ResponseHeadersVariable <String>]
       [-AdditionalProperties <Hashtable>]
       [-Criteria <IMicrosoftGraphSynchronizationJobRestartCriteria>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Restart-MgServicePrincipalSynchronizationJob
       -InputObject <IApplicationsIdentity>
       -BodyParameter <IPaths7MrbavServiceprincipalsServiceprincipalIdSynchronizationJobsSynchronizationjobIdMicrosoftGraphRestartPostRequestbodyContentApplicationJsonSchema>
       [-ResponseHeadersVariable <String>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.

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 = @{
	criteria = @{
		resetScope = "Watermark, Escrows, QuarantineState"
	}
}

Restart-MgServicePrincipalSynchronizationJob -ServicePrincipalId $servicePrincipalId -SynchronizationJobId $synchronizationJobId -BodyParameter $params

This example shows how to use the Restart-MgServicePrincipalSynchronizationJob Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPaths7MrbavServiceprincipalsServiceprincipalIdSynchronizationJobsSynchronizationjobIdMicrosoftGraphRestartPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-Criteria

synchronizationJobRestartCriteria To construct, see NOTES section for CRITERIA properties and create a hash table.

Type:	IMicrosoftGraphSynchronizationJobRestartCriteria
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

-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

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
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

-ServicePrincipalId

The unique identifier of servicePrincipal

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SynchronizationJobId

The unique identifier of synchronizationJob

Type:	String
Position:	Named
Default value:	None
Required:	True
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.IPaths7MrbavServiceprincipalsServiceprincipalIdSynchronizationJobsSynchronizationjobIdMicrosoftGraphRestartPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

System.Boolean

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 <IPaths7MrbavServiceprincipalsServiceprincipalIdSynchronizationJobsSynchronizationjobIdMicrosoftGraphRestartPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Criteria <IMicrosoftGraphSynchronizationJobRestartCriteria>]: synchronizationJobRestartCriteria
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ResetScope <String>]: synchronizationJobRestartScope

CRITERIA <IMicrosoftGraphSynchronizationJobRestartCriteria>: synchronizationJobRestartCriteria

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ResetScope <String>]: synchronizationJobRestartScope

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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.applications/restart-mgserviceprincipalsynchronizationjob
• https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0