Start-VBOOrganizationSynchronization

Short Description

Starts to synchronize 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

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

[-Parts <VBOOrganizationSyncParts>] [<CommonParameters>]

Detailed Description

This cmdlet starts to synchronize Microsoft organization objects with the organization cache database. Veeam Backup for Microsoft 365 uses the organization cache database to store information about all restore points created for Microsoft 365 organizations and to index all objects in Microsoft 365 organizations with modern app-only authentication.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Full	Defines that the cmdlet will start synchronization of all objects in this Microsoft organization. Default: False	`SwitchParameter`	False	Named	False
Organization	Specifies a Microsoft organization. The cmdlet will start synchronization of objects for this Microsoft organization. IVBOOrganization Accepts the `VBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`IVBOOrganization`	True	Named	True (ByValue)
Parts	Specifies the organization parts that the cmdlet will synchronize. You can specify several parts separated by a comma: `Users` `Groups` `GroupMembers` `Sites` `Mailboxes` `All` Default: All	`VBOOrganizationSyncParts`	False	Named	False

<CommonParameters>

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

Examples

Start-VBOOrganizationSynchronization 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.

Start-VBOOrganizationSynchronization Example 2: Synchronizing Specific Organization Parts with Organization Cache Database

This example shows how to start synchronizing the users and sites of the abc.onmicrosoft.com Microsoft organization with the organization cache database.

$org = Get-VBOOrganization -Name abc.onmicrosoft.com

Start-VBOOrganizationSynchronization -Organization $org -Parts Users, Sites

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Start-VBOOrganizationSynchronization cmdlet. Set the $org variable as the Organization parameter value. Specify the Users and Sites values for the Parts parameter.

Get-VBOOrganization