Remove-VBOBackupItem

In this article

    Short Description

    Removes an object from a backup job.

    Syntax

    Remove-VBOBackupItem -Job <VBOJob> -BackupItem <VBOBackupItem[]> [<CommonParameters>]

    Detailed Description

    This cmdlet removes an object from a backup job.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a backup job. The cmdlet will remove an object from this backup job.

    Accepts the VBOJob object.

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

    True

    Named

    False

    False

    BackupItem

    Specifies an object. The cmdlet will remove this object from the backup job.

    Accepts the VBOBackupItem[] object.

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

    True

    Named

    False

    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-VBOBackupItemExample 1. Removing Backup Item by Name

    This example shows how to remove a Microsoft Exchange or Microsoft SharePoint object from the scope of the TestJob backup job even if this object is no longer available in Microsoft organization.

    $job = Get-VBOJob -Name "TestJob"

    $item = Get-VBOBackupItem -Job $job -Name "ObjectToRemove"

    Remove-VBOBackupItem -Job $job -BackupItem $item

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBOBackupItem cmdlet. Set the $job variable as the Job parameter value and specify the Name parameter value to select the item in the backup job. Save the result to the $item variable.
    3. Run the Remove-VBOBackupItem cmdlet with the $job and $item variables to remove the selected object from the specified backup job.

    Remove-VBOBackupItemExample 2. Removing User Backup Item

    This example shows how to remove an organization user UserAlpha backup item from the TestJob backup job.

    $org = Get-VBOOrganization -Name "ABC Company"

    $user = Get-VBOOrganizationUser -Organization $org -Name "UserAlpha"

    $backupItemUser = New-VBOBackupItem -User $user -Mailbox:$True -ArchiveMailbox:$False -OneDrive:$False

    $job = Get-VBOJob -Name "TestJob"

    Remove-VBOBackupItem -Job $job -BackupItem $backupItemUser

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet to get an organization. Save the result to the $org variable.
    2. Run the Get-VBOOrganizationUser cmdlet to get an organization user. Save the result to the $user variable.
    3. Run the New-VBOBackupItem cmdlet to select the item in the backup job. Save the result to the $backupItemUser variable.
    4. Run the Get-VBOJob cmdlet to select the backup job for modification. Save the result to the $job variable.
    5. Run the Remove-VBOBackupItem cmdlet with the $job and $backupItemUser variables to remove the selected user from the specified backup job.

    Related Commands