< Back
Remove-PowerBIWorkspaceUser
Post
NAME Remove-PowerBIWorkspaceUser
SYNOPSIS
Removes permissions to a Power BI workspace for the specified user.
SYNTAX
Remove-PowerBIWorkspaceUser -Id <Guid> [-Scope {Individual | Organization}] -UserPrincipalName <String>
[<CommonParameters>]
Remove-PowerBIWorkspaceUser [-Scope {Individual | Organization}] -UserPrincipalName <String> -Workspace
<Workspace> [<CommonParameters>]
DESCRIPTION
Removes permissions for a specified user to a Power BI workspace using the provided inputs and scope specified.
Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.
PARAMETERS
-Id <Guid>
ID of the workspace the user should be removed from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <PowerBIUserScope>
Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization
operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the
default.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UserPrincipalName <String>
User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Workspace <Workspace>
The workspace entity to remove the user from.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-PowerBIWorkspaceUser -Scope Organization -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress
john@contoso.com
Removes permissions for user john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 within the
caller's organization.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-PowerBIWorkspaceUser -Scope Individual -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress
john@contoso.com
Removes permissions for john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50, which is a
workpace the caller owns.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... -powerbiwo
rkspaceuser?view=powerbi-ps
SYNOPSIS
Removes permissions to a Power BI workspace for the specified user.
SYNTAX
Remove-PowerBIWorkspaceUser -Id <Guid> [-Scope {Individual | Organization}] -UserPrincipalName <String>
[<CommonParameters>]
Remove-PowerBIWorkspaceUser [-Scope {Individual | Organization}] -UserPrincipalName <String> -Workspace
<Workspace> [<CommonParameters>]
DESCRIPTION
Removes permissions for a specified user to a Power BI workspace using the provided inputs and scope specified.
Before you run this command, make sure you log in using Connect-PowerBIServiceAccount.
PARAMETERS
-Id <Guid>
ID of the workspace the user should be removed from.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <PowerBIUserScope>
Indicates scope of the call. Individual operates against only workspaces assigned to the caller; Organization
operates against all workspaces within a tenant (must be an administrator to initiate). Individual is the
default.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UserPrincipalName <String>
User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Workspace <Workspace>
The workspace entity to remove the user from.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Remove-PowerBIWorkspaceUser -Scope Organization -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress
john@contoso.com
Removes permissions for user john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 within the
caller's organization.
-------------------------- Example 2 --------------------------
PS C:\\> Remove-PowerBIWorkspaceUser -Scope Individual -Id 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50 -UserEmailAddress
john@contoso.com
Removes permissions for john@contoso.com on workspace with ID 23FCBDBD-A979-45D8-B1C8-6D21E0F4BE50, which is a
workpace the caller owns.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... -powerbiwo
rkspaceuser?view=powerbi-ps