Remove-VBOEntityData - Veeam Backup for Microsoft 365 PowerShell Reference

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Repository	Specifies a backup repository where the backed-up data entity is located.	Accepts the VBORepository object. To get this object, run the Get-VBORepository cmdlet.	True	Named	False	False
User	Specifies an organization user entity.	VBOUserData	True	Named	True (ByValue)	False
Mailbox	Defines that this cmdlet will remove the entity mailbox data.	SwitchParameter	False	Named	False	False
ArchiveMailbox	Defines that this cmdlet will remove the entity archive mailbox data.	SwitchParameter	False	Named	False	False
OneDrive	Defines that this cmdlet will remove the entity OneDrive data.	SwitchParameter	False	Named	False	False
Sites	Defines that this cmdlet will remove the entity sites data.	SwitchParameter	False	Named	False	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False	False
WhatIf	Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False	False
Confirm	Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue. Default: True	SwitchParameter	False	Named	False	False
Group	Specifies an organization group entity.	VBOGroupData	True	Named	True (ByValue)	False
GroupMailbox	Defines that this cmdlet will remove the organization group mailbox data.	SwitchParameter	False	Named	False	False
GroupSite	Defines that this cmdlet will remove the organization group site data.	SwitchParameter	False	Named	False	False
Site	Specifies an organization site entity.	VBOSiteData	True	Named	True (ByValue)	False
Team	Specifies an organization team entity.	VBOTeamData	True	Named	True (ByValue)	False

This example shows how to remove data of a user with the name Chuck Brown.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$user = Get-VBOEntityData -Type User -Repository $repository -Name "Chuck Brown"

Remove-VBOEntityData -Repository $repository -User $user -Mailbox -ArchiveMailbox -OneDrive -Sites

Perform the following steps:

Run the Get-VBORepository cmdlet with the Name parameter to get the repository. Save the result to the $repository variable.
Run the Get-VBOEntityData cmdlet with the Name parameter and the $repository variable. Save result to the $user variable.
Run the Remove-VBOEntityData cmdlet with the $repository and $user variables and Mailbox, ArchiveMailbox, OneDrive and Sites parameters to remove the data.

This example shows how to remove data of an organization group with the name Support.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$group = Get-VBOEntityData -Type Group -Repository $repository -Name "Support"

Remove-VBOEntityData -Repository $repository -Group $group -Mailbox -ArchiveMailbox -OneDrive -Sites -GroupMailbox -GroupSite

Perform the following steps:

Run the Get-VBORepository cmdlet with the Name parameter to get the source repository. Save the result to the $repository variable.
Run the Get-VBOEntityData cmdlet with the Name parameter and the $repository variable. Save result to the $group variable.
Run the Remove-VBOEntityData cmdlet with the $repository and $group variables and Mailbox, ArchiveMailbox, OneDrive, Sites, GroupMailbox and GroupSite parameters to remove the data.

This example shows how to remove data of an organization site with the name Support.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$site = Get-VBOEntityData -Type Site -Repository $repository -Name "Support"

Remove-VBOEntityData -Repository $repository -Site $site

Perform the following steps:

Run the Get-VBORepository cmdlet with the Name parameter to get the source repository. Save the result to the $repository variable.
Run the Get-VBOEntityData cmdlet with the Name parameter and the $repository variable. Save result to the $site variable.
Run the Remove-VBOEntityData cmdlet with the $repository and $site variables to remove the data.

This example shows how to remove data of a user with the name Chuck Brown from a specific backup repository extended with Azure Blob Storage Archive that was specified as a target for backup copy jobs.

$archiverepo = Get-VBORepository -Name "Azure Blob Storage Archive" -LongTerm

$user = Get-VBOEntityData -Type User -Repository $archiverepo -Name "Chuck Brown"

Remove-VBOEntityData -Repository $archiverepo -User $user -Mailbox -ArchiveMailbox -OneDrive -Sites

Perform the following steps:

Run the Get-VBORepository cmdlet with the Name parameter. Provide the LongTerm parameter. Save the result to the $archiverepo variable.
Run the Get-VBOEntityData cmdlet with the Name parameter and the $archiverepo variable. Save result to the $user variable.
Run the Remove-VBOEntityData cmdlet with the $archiverepo and $user variables and Mailbox, ArchiveMailbox, OneDrive and Sites parameters to remove the data.