Remove-PowerBIWorkspaceUser
Removes permissions to a Power BI workspace for the specified user.
Syntax
Id (Default)
Remove-PowerBIWorkspaceUser
-Id <Guid>
-UserPrincipalName <String>
[-Scope <PowerBIUserScope>]
[<CommonParameters>]
Workspace
Remove-PowerBIWorkspaceUser
-UserPrincipalName <String>
-Workspace <Workspace>
[-Scope <PowerBIUserScope>]
[<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.
Examples
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.
Parameters
-Id
ID of the workspace the user should be removed from.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | GroupId, WorkspaceId |
Parameter sets
Id
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Scope
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.
Parameter properties
| Type: | PowerBIUserScope |
| Default value: | None |
| Accepted values: | Individual, Organization |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserPrincipalName
User Principal Name (or UPN, commonly an email address) for the user whose permissions need to be removed.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | UserEmailAddress |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Workspace
The workspace entity to remove the user from.
Parameter properties
| Type: | Workspace |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Group |
Parameter sets
Workspace
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.