This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBOOrganizationSynchronization

Short Description

Starts to synchronize Microsoft organization objects with the organization cache database.

Start-VBOOrganizationSynchronization Note

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

Syntax

Start-VBOOrganizationSynchronization -Organization <IVBOOrganization> [-Full <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet starts to synchronize Microsoft organization objects with the organization cache database.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Organization	Specifies a Microsoft organization. The cmdlet will start synchronization of objects in this Microsoft organization.	IVBOOrganization Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.	True	Named	True (ByValue)	False
Full	Defines that the cmdlet will start synchronization of all objects in this Microsoft organization.	SwitchParameter	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Organization

Specifies a Microsoft organization. The cmdlet will start synchronization of objects in this Microsoft organization.

IVBOOrganization

Accepts the VBOOrganization object.

To get this object, run the Get-VBOOrganization cmdlet.

True

Named

True (ByValue)

False

Full

Defines that the cmdlet will start synchronization of all objects in this Microsoft organization.

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Example 1. Synchronizing All Microsoft Organization Objects with Organization Cache Database

This example shows how to start synchronizing all Microsoft organization objects with the organization cache database.

$orgs = Get-VBOOrganization

foreach ($org in $orgs) { Start-VBOOrganizationSynchronization -Organization $org -Full:$true }

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Save the result to the $orgs variable.
Run the Start-VBOOrganizationSynchronization cmdlet. Set the $org variable as the Organization parameter value. Set the :$true value for the Full parameter.

Related Commands

Get-VBOOrganization