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
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. | True | Named | True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBOOrganizationSynchronizationState object that contains details on the synchronization status of the organization objects with the organization cache database.
Example
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/2023 4:54:11 PM Error : |
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.
Related Commands