Get-DataGatewayCluster

  • Reference
Module:
DataGateway

Get gateway clusters for the current user

Syntax

Get-DataGatewayCluster
   [-Scope <PowerBIUserScope>]
   [-RegionKey <String>]
   [-GatewayClusterId <Guid>]
   [<CommonParameters>]

Description

Get gateway cluster that matches the specified cluster ID and for which the current user is an administrator of. If no cluster ID is specified, all gateway clusters for which the user is an admin will be returned.

Examples

Example 1

PS C:\> Get-DataGatewayCluster

Get all gateway clusters for which the current user is an admin of.

Example 2

PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77

Get gateway cluster details for the specified gateway cluster ID "DC8F2C49-5731-4B27-966B-3DB5094C2E77"

Example 3

PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 | Select -ExpandProperty MemberGateways

Get details of each member gateway associated with the specified gateway cluster ID "DC8F2C49-5731-4B27-966B-3DB5094C2E77".

Example 4

PS C:\> Get-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 | Select -ExpandProperty Permissions

Get a list of users with permissions to administer or use the gateway cluster "DC8F2C49-5731-4B27-966B-3DB5094C2E77".

Example 5

PS C:\> Get-DataGatewayCluster -Scope Organization

Get all gateway clusters within your organization. NOTE: You must be an O365 tenant admin, Power Platform admin or a Power BI admin for the -Scope Organization option to work.

Example 6

PS C:\> Get-DataGatewayCluster -RegionKey brazilsouth

Gets gateway clusters you are an administrator of and are associated to the the Brazil south region.

Parameters

-GatewayClusterId

ID for unique to a gateway cluster

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

-RegionKey

The Azure region associated to the gateway. When a -RegionKey isn't provided, the default Power BI region for your tenant is used. To get the list of available region parameters run the Get-DataGatewayRegion cmdlet

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

Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayCluster