Data Gateway PowerShell module issue with `Add-DataGatewayClusterMember` command `-RegionKey` param

Seems like API requests are missing "&region=westeurope" parameter at the end of URI, or region specific API endpoint is not filtering data (gateways in that case) per region.

PS C:\Users\vagrant> add-datagatewaycluster -RecoveryKey $secureRecoveryKey -Name DataGatewayPoC -OverwriteExistingGateway -RegionKey westeurope -Verbose -Debug
DEBUG: 12:18:57 - Add-DataGatewayCluster begin processing with ParameterSet __AllParameterSets.
DEBUG: 12:18:57 - Cmdlet version: 3000.196.145
VERBOSE: Request Uri: https://api.powerbi.com/v2.0/myorg/me/gatewayRegions
VERBOSE: Status Code: OK (200)
VERBOSE: Request Uri: https://wabi-west-europe-redirect.analysis.windows.net/v2.0/myorg/me/gatewayClusters?$expand=permissions,memberGateways
VERBOSE: Status Code: OK (200)
VERBOSE: Request Uri: https://wabi-west-europe-redirect.analysis.windows.net/unifiedgateway/gateways/CreateGatewayWithApps
VERBOSE: Status Code: OK (200)
DEBUG: Microsoft.PowerBI.DataMovement.ExternalContracts.API.CreateGatewayResponse

DEBUG: 12:19:02 - Add-DataGatewayCluster end processing.
GatewayId GatewayObjectId                      GatewayName    GatewayType
--------- ---------------                      -----------    -----------
xxxxxxx   xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx DataGatewayPoC Resource

PS C:\> Add-DataGatewayClusterMember -RegionKey westeurope -GatewayName "DataGatewayPoC-2" -RecoveryKey $secureRecoveryKey -OverwriteExistingGateway -Debug -Verbose -GatewayClusterId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
DEBUG: 12:19:51 - Add-DataGatewayClusterMember begin processing with ParameterSet __AllParameterSets.
DEBUG: 12:19:51 - Cmdlet version: 3000.196.145
VERBOSE: Request Uri: https://api.powerbi.com/v2.0/myorg/me/gatewayRegions
VERBOSE: Status Code: OK (200)
VERBOSE: Request Uri: https://wabi-west-europe-redirect.analysis.windows.net/v2.0/myorg/me/gatewayClusters?$expand=permissions,memberGateways
VERBOSE: Status Code: OK (200)
Add-DataGatewayClusterMember: Gateway cluster xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was not found
DEBUG: System.ArgumentException: Gateway cluster xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was not found
   at Microsoft.DataMovement.Powershell.Commands.DataGateway.AddDataGatewayClusterMember.ExecuteCmdletAsync()
   at Microsoft.DataMovement.Powershell.Commands.Common.PowerBICmdlet.ProcessRecordAsync()
DEBUG: 12:19:52 - Add-DataGatewayClusterMember end processing.

PS C:\Users\vagrant> get-dataGatewayCluster -RegionKey westeurope -Verbose -Debug
DEBUG: 12:29:37 - Get-DataGatewayCluster begin processing with ParameterSet __AllParameterSets.
DEBUG: 12:29:37 - Cmdlet version: 3000.196.145
VERBOSE: Request Uri: https://api.powerbi.com/v2.0/myorg/me/gatewayClusters?$expand=permissions,memberGateways&region=westeurope
VERBOSE: Status Code: OK (200)

Id                    : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Name                  : DataGatewayPoC
Description           :
Permissions           : {app-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, app-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
                        xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
Type                  : Resource
MemberGateways        : {DataGatewayPoC}
Datasources           : {}
LoadBalancingSettings :
AllowableOptions      : Microsoft.PowerBI.ServiceContracts.Api.ODataDictionary`1[System.Boolean]
StaticCapabilities    : 0
MaxPermission         : Microsoft.PowerBI.ServiceContracts.Api.Permission

DEBUG: 12:29:38 - Get-DataGatewayCluster end processing.

Thank you hackcrr 

Hi, mikeeq 

I apologize for my late reply. I did a complete test based on the code you are using. During the test, the gateway module honors the region parameter. Here are the results of my tests:

First, I updated my PowerShell to version 7.4.3 using the following commands:

winget source reset --force
winget source update
winget install --id Microsoft.Powershell --source winget

I installed the gateway module using the following command:

Install-Module -Name OnPremisesDataGatewayHAMgmt
Install-Module -Name DataGateway

Import the gateway module in PowerShell and view the gateway version:

Import-Module DataGateway
(Get-Module DataGateway).version

Next log into my gateway account:

Login-DataGatewayServiceAccount

(Get-Item "C:\Program Files\On-premises data gateway\Microsoft.PowerBI.EnterpriseGateway.exe").VersionInfo.FileVersion

Use the following command to get the zone of the gateway to see which zone my current gateway is installed in:

Get-DataGatewayRegion

Add a gateway cluster member to the gateway region:

Add-DataGatewayClusterMember -GatewayClusterId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -GatewayName datagatewaypoc-2 -RecoveryKey $secureRecoveryKey -OverwriteExistingGateway -RegionKey uksouth

You can see that we were also able to add the gateway member without any problems when we specified the RegionKey uksouth.

Use your debug command below to test that the Power BI API automatically redirects to the specified region when you add a gateway cluster member:

PS C:\> Add-DataGatewayClusterMember -RegionKey uksouth -GatewayName "DataGatewayPoC-4" -RecoveryKey $secureRecoveryKey -OverwriteExistingGateway -Debug -Verbose -GatewayClusterId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Use the following command to get the just added gateway cluster:

 get-dataGatewayCluster -RegionKey uksouth -Verbose -Debug

During this entire test, the gateway module worked fine. You can try to add the gateway cluster members again using PowerShell commands. Or you can perform the operation in another computer.
In addition to this, you can choose an alternative solution: add the gateway cluster using the local data gateway software.

Best Regards

Jianpeng Li

If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

Hi, mikeeq 

Do you have the GatewayClusterId used by the check, and the gateway cluster is indeed deployed in that region. An incorrect GatewayClusterId is causing the current issue.

Best Regards

Jianpeng Li

If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.

Hi, mikeeq 

First, ensure that you are using the latest version of the DataGateway module. You can update the module using the following command:

Update-Module DataGateway

Double-check the syntax and ensure that the

-RegionKey

 parameter is correctly specified. PowerShell parameters are case-sensitive, so make sure you're using the exact region key.

As a temporary workaround, you can try deploying the gateway cluster in the default Power BI tenant region if possible. If this is not feasible, continue using the manual process without the RegionKey parameter until a fix is available.

Here are examples of how you might use the commands with and without the -RegionKey parameter:

Without -RegionKey Parameter (Default Region)

$secureRecoveryKey = ConvertTo-SecureString "YourRecoveryKey" -AsPlainText -Force
Add-DataGatewayClusterMember -GatewayClusterId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -GatewayName "datagatewaypoc-2" -RecoveryKey $secureRecoveryKey -OverwriteExistingGateway

With -RegionKey Parameter (Specific Region)

$secureRecoveryKey = ConvertTo-SecureString "YourRecoveryKey" -AsPlainText -Force
Add-DataGatewayClusterMember -GatewayClusterId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -GatewayName "datagatewaypoc-2" -RecoveryKey $secureRecoveryKey -OverwriteExistingGateway -RegionKey "uksouth"

Try using the Get-DataGatewayCluster command with the -RegionKey parameter to see if it works correctly:

Get-DataGatewayCluster -RegionKey "uksouth"

If the -RegionKey parameter works with other commands, it indicates that the issue is specific to the Add-DataGatewayClusterMember command.

hackcrr

If this post helps, then please consider Accept it as the solution and kudos to this post to help the other members find it more quickly