Remove-DataGatewayClusterUser

Reference

Module:: DataGateway

Removes users (including admins) from a gateway cluster

Syntax

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

Type:	Guid
Aliases:	Cluster, Id
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PrincipalObjectId

Azure Active Directory (AAD) principal object ID (i.e. user ID) of the user to be removed

Type:	Guid
Aliases:	User
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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

Type:	PowerBIUserScope
Accepted values:	Individual, Organization
Position:	Named
Default value:	Individual
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

System.Void