Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Start-MgServicePrincipalSynchronizationJob

Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don't create scripts to call the start job continuously while it's running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine.

Note

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

Syntax

Start (Default) 

Start-MgServicePrincipalSynchronizationJob
 -ServicePrincipalId <string>
 -SynchronizationJobId <string>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

StartViaIdentity 

Start-MgServicePrincipalSynchronizationJob
 -InputObject <IApplicationsIdentity>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-PassThru]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don't create scripts to call the start job continuously while it's running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Synchronization.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application Application.ReadWrite.OwnedBy, Synchronization.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Applications

Start-MgServicePrincipalSynchronizationJob -ServicePrincipalId $servicePrincipalId -SynchronizationJobId $synchronizationJobId

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

Parameters

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IApplicationsIdentity
Supports wildcards:False
DontShow:False

Parameter sets

-PassThru

Returns true when the command succeeds

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

-ServicePrincipalId

The unique identifier of servicePrincipal

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-SynchronizationJobId

The unique identifier of synchronizationJob

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IApplicationsIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

System.Boolean

{{ Fill in the Description }}

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.

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