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

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

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

    True

    Named

    False

    False

    BackupItem

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

    False

    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.

    Examples

    Example 1

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

    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.

    $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

    Related Commands