Remove-DataGatewayClusterUser
Removes users (including admins) from a gateway cluster
Syntax
Default (Default)
Remove-DataGatewayClusterUser
[-Scope <PowerBIUserScope>]
[-RegionKey <String>]
-GatewayClusterId <Guid>
-PrincipalObjectId <Guid>
[<CommonParameters>]
Description
Removes users (including admins) from a gateway cluster
Examples
Example 1
PS C:\> $userToRemove = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id
PS C:\> Remove-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToRemove
Removes user "testUpn@tenant.com" from the gateway cluster.
Example 2
PS C:\> $userToRemove = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id
PS C:\> Remove-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToRemove -RegionKey brazilsouth
Removes the user "testUpn@tenant.com" from the gateway cluster. This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.
Parameters
-GatewayClusterId
Gateway cluster where the user needs to be removed
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Cluster, Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrincipalObjectId
Azure Active Directory (AAD) principal object ID (i.e. user ID) of the user to be removed
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | User |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RegionKey
The region in which this command has to run in. Not providing a -RegionKey will run the command in the default region for your tenant.
To get the list of available region parameters run the Get-DataGatewayRegion command
Parameter properties
| Type: | String |
| Default value: | None |
| 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 |
-Scope
Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin
Parameter properties
| Type: | PowerBIUserScope |
| Default value: | Individual |
| 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 |
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.