Remove-VBOEntityData

In this article

    Short Description

    Removes an organization entity data from a backup repository including a backup repository extended with an archive object storage.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Remove organization user data.

    Remove-VBOEntityData -Repository <VBORepository> -User <VBOUserData> [-Mailbox <switchparameter>] [-ArchiveMailbox <switchParameter>] [-OneDrive <switchparameter>] [-Sites <switchparameter>] [-RunAsync <switchparameter>] [-WhatIf <switchparameter>] [-Confirm <switchparameter>] [<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>]

    • Remove organization team data.

    Remove-VBOEntityData -Repository <VBORepository> -Team <VBOTeamData> [-RunAsync <switchparameter>] [-WhatIf <switchparameter>] [-Confirm <switchparameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet removes the organization entity data.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Repository

    Specifies a location of the backed-up data entity.

    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.

    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

    <CommonParameters>

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

    Output Object

    None.

    Examples

    Remove-VBOEntityDataExample 1. Removing User Data

    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:

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

    Remove-VBOEntityDataExample 2. Removing Group 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:

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

    Remove-VBOEntityDataExample 3. Removing Site 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:

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

    Remove-VBOEntityDataExample 4. Removing User Data From Backup Repository Extended with Archive Storage

    This example shows how to remove data of a user with the name Chuck Brown from a specific backup repository extended with an archive object storage.

    $archiverepo = Get-VBORepository -Name "Azure Archive Storage" -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:

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

    Related Commands