Get-DataGatewayClusterStatus

  • Reference
Module:
DataGateway

Gets gateway cluster status

Syntax

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

Description

Gets status of a particular gateway cluster.

Examples

Example 1

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

Gets the status of the gateway cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77.

Example 2

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

Gets the status of the gateway 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

Cluster to get status of

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

-RegionKey

The region to which the specified gateway belongs to. 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:Individual
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.GatewayClusterStatusResponse