Remove-VBRUserRoleAssignment

In this article

    Short Description

    Removes a role from a user or a user group.

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

    Syntax

    Remove-VBRUserRoleAssignment -Assignment <VBRUserRoleAssignment>  [<CommonParameters>]

    Detailed Description

    This cmdlet removes a role from a user or a user group.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Assignment

    Specifies a user or a user group from which you want to remove a role.

    Accepts the VBRUserRoleAssignment object. To create this object, run the Get-VBRUserRoleAssignment cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    <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

    Removing Role from User

    This example shows how to remove a role that is assigned to the Tech\BackupAdmin user.

    $role = Get-VBRUserRoleAssignment -Name Tech\BackupAdmin

    Remove-VBRUserRoleAssignment -Assignment $role

    Perform the following steps:

    1. Run the Get-VBRUserRoleAssignment cmdlet. Save the result to the $role variable.
    2. Run the Remove-VBRUserRoleAssignment cmdlet. Set the $role variable as the Assignment parameter value.

    Related Commands

    Get-VBRUserRoleAssignment

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.