Monitoring On-Premises Data Gateways Using PowerShell

The On-Premises Data Gateway is a very important component when orchestrating events from the cloud to local networks. Whether you are using the gateway for Robotic Process Automation (RPA) processes or for calling on-premises databases through Azure Logic Apps or Power Automate, it becomes imperative that there is monitoring on that component.

The Power BI team has published Powershell CMDlets that allow you to call administrative operations against the Power BI APIs. More specifically we can use the Get-DataGatewayCluster operation to return a list of On-Premises Data Gateways in our tenant. As part of this call, we will receive a list that also included the ID of the gateway

Get-DataGatewayCluster -Scope Organization | Out-File -FilePath C:\temp\GatewayList.txt 

Once we have the list of gateways, and their respective IDs, we can make a subsequent call using the Get-DataGatewayClusterStatus operation when passing in an ID as a parameter.

Get-DataGatewayClusterStatus -Scope Organization -GatewayClusterId $args[0] 

The result of this call will return a ClusterStatus of None, when the gateway is offline and a value of Live when the gateway is online.

To see how you can orchestrate these calls using Power Automate Desktop, please refer to this complementary video on YouTube. Using this approach allows us to build out an Excel spreadsheet that contains an inventory of all of our gateways and their respective status.