Remove-DataGatewayCluster
Removes a gateway cluster. This does not uninstall the gateway from the gateway member machine(s).
Syntax
Default (Default)
Remove-DataGatewayCluster
[-Scope <PowerBIUserScope>]
[-RegionKey <String>]
-GatewayClusterId <Guid>
[<CommonParameters>]
Description
Remove a gateway cluster
Examples
Example 1
PS C:\> Remove-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77
Remove the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77
Example 2
PS C:\> Remove-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -RegionKey brailsouth
Remove 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 ID of the gateway cluster 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 |
-RegionKey
The region associated to the gateway to be removed . 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.