Remove-DataGatewayCluster

  • Reference
Module:
DataGateway

Removes a gateway cluster. This does not uninstall the gateway from the gateway member machine(s).

Syntax

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

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

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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Void