Get-DataGatewayCluster
Get gateway clusters for the current user
Syntax
Default (Default)
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
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Cluster, Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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
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: | Individual |
| 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.