Get-VBOOrganizationSynchronizationState

Short Description

Returns status of synchronization of Microsoft organization objects with the organization cache database.

Note

Synchronization of objects with the organization cache database is only available for Microsoft organizations with modern app-only authentication.

Syntax

Get-VBOOrganizationSynchronizationState -Organization <IVBOOrganization> [<CommonParameters>]

Detailed Description

This cmdlet returns status of synchronization of Microsoft organization objects with the organization cache database.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Organization	Specifies a Microsoft organization. The cmdlet will return synchronization status for objects of this Microsoft organization. IVBOOrganization Accepts the `VBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`IVBOOrganization`	True	Named	True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOOrganizationSynchronizationState object that contains details on the synchronization status of the organization objects with the organization cache database.

The CurrentState property contains details about the synchronization that is currently queued or running. The Parts property contains the synchronization state of every organization part that is synchronized independently: users, groups, group members, sites and mailboxes. A part is empty if it is outside the organization synchronization scope.

Examples

Getting Synchronization Status

This example shows how to get status of synchronization of Microsoft organization objects with the organization cache database.

$org = Get-VBOOrganization

Get-VBOOrganizationSynchronizationState -Organization $org

Organization : abc.onmicrosoft.com

SyncStatus : Success

Type : Incremental

LastSyncTime : 10/5/2025 4:54:11 PM

Error :

CurrentState : Queued (Incremental)

Parts : Users, Groups, GroupMembers, Sites

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the Get-VBOOrganizationSynchronizationState cmdlet. Set the $org variable as the Organization parameter value.

Get-VBOOrganization