Remove-DataGatewayClusterMember
Remove gateway from gateway cluster. This does not uninstall the gateway from the machine.
Syntax
Default (Default)
Remove-DataGatewayClusterMember
[-Scope <PowerBIUserScope>]
[-RegionKey <String>]
-GatewayClusterId <Guid>
-MemberGatewayId <Guid>
[<CommonParameters>]
Description
Remove gateway from gateway cluster
Examples
Example 1
PS C:\> Remove-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -MemberGatewayId E407A364-3A89-4E21-8791-C108DB41E75A
Remove the gateway with ID E407A364-3A89-4E21-8791-C108DB41E75A from the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77
Example 2
PS C:\> Remove-DataGatewayClusterMember -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -MemberGatewayId E407A364-3A89-4E21-8791-C108DB41E75A -RegionKey brazilsouth
Remove the gateway with ID E407A364-3A89-4E21-8791-C108DB41E75A from the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77 This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.
Parameters
-GatewayClusterId
The gateway cluster of which the to-be removed gateway is a member.
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 |
-MemberGatewayId
The member to be removed from the gateway cluster
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
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 associated with the specified gateway cluster. 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: | 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 |
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.