Remove-VBOEntityData
Short Description
Removes an organization entity data from a repository.
Syntax
This cmdlet provides the following parameter sets.
- Remove organization user data
Remove-VBOEntityData -Repository <VBORepository> -User <VBOUserData> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [-WhatIf] [-Confirm] [<CommonParameters>] |
- Remove organization group data
Remove-VBOEntityData -Repository <VBORepository> -Group <VBOGroupData> [-Mailbox [<SwitchParameter>]] [-ArchiveMailbox [<SwitchParameter>]] [-OneDrive [<SwitchParameter>]] [-Sites [<SwitchParameter>]] [-GroupMailbox [<SwitchParameter>]] [-GroupSite [<SwitchParameter>]] [-RunAsync [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>] |
- Remove organization site data
Remove-VBOEntityData -Repository <VBORepository> -Site <VBOSiteData> [-RunAsync [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>] |
Detailed Description
This cmdlet allows to remove the organization entities data.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Repository | Specifies the location of the entity backed up data. | True | Named | False | False |
User | Specifies the organization user entity. | True | Named | True (ByValue) | False |
Mailbox | Indicates that this cmdlet will remove the entity mailbox data. | False | Named | False | False |
ArchiveMailbox | Indicates that this cmdlet will remove the entity archive mailbox data. | False | Named | False | False |
OneDrive | Indicates that this cmdlet will remove the entity OneDrive data. | False | Named | False | False |
Sites | Indicates that this cmdlet will remove the entity sites data. | False | Named | False | False |
RunAsync | Indicates that the command returns immediately without waiting for the task to complete. | False | Named | False | False |
WhatIf | Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action. | False | Named | False | False |
Confirm | Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. | False | Named | False | False |
Group | Specifies the organization group entity. | True | Named | True (ByValue) | False |
GroupMailbox | Indicates that this cmdlet will remove the organization group mailbox data. | False | Named | False | False |
GroupSite | Indicates that this cmdlet will remove the organization group site data. | False | Named | False | False |
Site | Specifies the organization site entity. | True | Named | True (ByValue) | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Example 1
This example shows how to remove data of a user with a name "Chuck Brown".
- Run Get-VBORepository with a Name parameter to get the repository. Save the result to the $repository variable.
- Run Get-VBOEntityData with a Name parameter and a $repository variable. Save result to the $user variable.
- Run Remove-VBOEntityData with the $repository and $user variables and Mailbox, ArchiveMailbox, OneDrive and Sites parameters to remove the corresponding data.
$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 |
Example 2
This example shows how to remove data of an organization group with a name "support".
- Run Get-VBORepository with a Name parameter to get the source repository. Save the result to the $repository variable.
- Run Get-VBOEntityData with a Name parameter and a $repository variable. Save result to the $group variable.
- Run Remove-VBOEntityData with the $repository and $group variables and Mailbox, ArchiveMailbox, OneDrive, Sites, GroupMailbox and GroupSite parameters to remove the corresponding data.
$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 |
Example 3
This example shows how to remove data of an organization site with a name "support".
- Run Get-VBORepository with a Name parameter to get the source repository. Save the result to the $repository variable.
- Run Get-VBOEntityData with a Name parameter and a $repository variable. Save result to the $site variable.
- Run Remove-VBOEntityData with the $repository and $site variables to remove the corresponding data.
$repository = Get-VBORepository -Name "ABC Daily Backup" $site = Get-VBOEntityData -Type Site -Repository $repository -Name "support" Remove-VBOEntityData -Repository $repository -Site $site |
Related Commands