topic Re: How to remove the Power BI gateway using PowerShell or REST API in Developer

How to remove the Power BI gateway using PowerShell or REST API

tousinn — Wed, 11 Jan 2023 06:14:25 GMT

Hi team

We are trying to delete Power BI gateway by using PowerShell module or REST API.

We tried to use DataGateway PowerShell module to get the gateway first and remove it using the comdlets below.

============================

$PowerBIDataGatewayCluster = Get-DataGatewayCluster

if ($null -ne $PowerBIDataGatewayCluster -and "" -ne $PowerBIDataGatewayCluster) {

Write-Host "Revoke admin access for SPN from Power BI gateway $($PowerBIDataGatewayCluster.Name)"

Remove-DataGatewayCluster -GatewayClusterId $PowerBIDataGatewayCluster.Id

}

============================

It works well with my Azure accounts without any issue.

However, if we use the service principal, even if the service principal has the admin access to the PowerBI gateway,

the cmdlet is still not able to get the gateway or remove it. And I am getting unauthoried error.

Is that because the Power BI powershell moduel does not support Service Principal authencation?

Is there anyway we could automate this process?

Thanks!

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Thu, 12 Jan 2023 01:17:23 GMT

Why would you want to automate that operation? You don't want to mess with a gateway configuration unless absolutely necessary. Removing a gateway cluster member should be done judiciously (and can be done via the admin center UI too).

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Thu, 12 Jan 2023 02:14:17 GMT

Hi @lbendlin

This is a buiness requirement. We have one gateway for each customer and we would like to remove it once the customer is offboarded.

Yes, we noticed that the PowerShell cmdlet is able to remove the members

But we would like to remove the gateway itself as well, otherwise we will have heaps of gatway without being used anymore.

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Thu, 12 Jan 2023 13:52:48 GMT

If you must - there is a choreography to it.

1. List all gateways and all cluster members

2. Identify the anchor member

3. for each gateway, remove the members that are NOT the anchor

4. remove the anchor member.

Hint: The gatewayObjectId of the anchor member is the clusterObjectID

Note: This only removes the meta data on the Power BI Service. It does not do anything to your VMs.

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Fri, 13 Jan 2023 04:15:06 GMT

Thanks @lbendlin

Does this mean we still could only remove the members from the gateway?

I am trying to remove the gateway itself by using PowerShell or REST API using Service Principal.

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Fri, 13 Jan 2023 11:06:41 GMT

When you remove the anchor member the entire gateway registration will be gone and all connections on that gateway too.

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Mon, 16 Jan 2023 04:00:47 GMT

Hi @lbendlin

Thanks for the replies.

May I know what the anchor member is here?

We only have the Azure Service Principal Assigned to the Gateway, which is the admin for the gateway as well.

Is the Azure Service Principal the anchor member in this case?

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Mon, 16 Jan 2023 04:23:27 GMT

The anchor member is the primary VM registered as a gateway in a gateway cluster. It is a machine identifier, not a login identifier.

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Tue, 24 Jan 2023 23:09:51 GMT

Hi @lbendlin

Thanks for the reply.

What we are trying to do is to remove the whole gateway cluster by using service principal via PowerShell module or REST API, rather than removing individual gateway from the cluster.

Is it supported at the moment? If so, could we know what permissions are required for the service principal?

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Wed, 25 Jan 2023 00:03:11 GMT

There is no such thing. You need to remove the gateway cluster members individually.

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Wed, 25 Jan 2023 00:55:33 GMT

This cmdlet could remove the application gateway cluster though.

Remove-DataGatewayCluster (DataGateway) | Microsoft Learn

But it seems to be working with the actual Azure account, not the service principal?

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Wed, 25 Jan 2023 18:29:14 GMT

Oh wow, they added a lot of new cmdlets. The cmdlet probable enumerates the cluster members and deletes them one by one for you. Fair enough.

As for the service principal question - i'll have to try that on our side. Don't see any mention of limitations at the moment.

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Thu, 26 Jan 2023 22:09:33 GMT

Hey @lbendlin

Yeah I know, the limitations are not mentioned in the doc, but...

Have you tried that from your end?

Re: How to remove the Power BI gateway using PowerShell or REST API

tousinn — Thu, 26 Jan 2023 22:10:05 GMT

or is there any way we could connect to MS support directly on this?

Re: How to remove the Power BI gateway using PowerShell or REST API

lbendlin — Fri, 27 Jan 2023 13:51:46 GMT

You can raise an issue at https://issues.powerbi.com . If you have a Pro license you can consider raising a Pro ticket at https://powerbi.microsoft.com/en-us/support/pro/