Remove-VBRCloudSubUser

In this article

    Short Description

    Removes cloud subuser accounts.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Remove-VBRCloudSubUser -SubUser <IVBRCloudSubUser[]> [-WhatIf] [-Confirm] [<CommonParameters>]

    Detailed Description

    This cmdlet removes a selected cloud subuser account from Veeam Backup & Replication. You can remove the subuser accounts of the following types:

    • Simple cloud tenant accounts
    • vCD Cloud tenant accounts

    When you remove a subuser, all backups stored on the cloud repository on this subuser are removed permanently. The parent cloud user cannot undo this operation. The resources associated with this subuser account becomes available for use by the cloud user.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    SubUser

    Specifies the array of cloud subusers you want to remove. The subusers can have different parents.

    Accepts the IVBRCloudSubUser type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    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

    <CommonParameters>

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

    Return Type

    None

    Example

    This example shows how to remove a cloud subuser.

    1. Run Get-VBRCloudSubUser to get the subuser. Save the result to the $subuser variable.
    2. Run Remove-VBRCloudSubUser with the saved variable.

    $subuser = Get-VBRCloudSubUser -Name "Subuser 1"

    Remove-VBRCloudSubUser -SubUser $subuser

    Related Commands

    Get-VBRCloudSubUser