Add-DataGatewayCluster

Creates a new data gateway cluster once the gateway has been installed on a machine

Note: To use this cmdlet, your gateway version must be `3000.37.35` (April 2020) or higher.

Syntax

Add-DataGatewayCluster
   -RecoveryKey <SecureString>
   -GatewayName <String>
   [-RegionKey <String>]
   [-OverwriteExistingGateway]
   [<CommonParameters>]

Description

Creates a new data gateway cluster once the gateway has been installed on a machine

Examples

Example 1

PS C:\> Add-DataGatewayCluster -Name "MyNewGateway" -RecoveryKey (Read-Host "Enter Recovery Key" -AsSecureString)

Creates a new gateway named "MyNewGateway".

Example 2

PS C:\> ConvertFrom-SecureString -SecureString (Read-Host "Enter Recovery Key" -AsSecureString) | Out-File -FilePath .\encryptedRecoveryKey.txt
PS C:\> $secureRecoveryKey = (cat .\encryptedRecoveryKey.txt | ConvertTo-SecureString)
PS C:\> Add-DataGatewayCluster -RecoveryKey $secureRecoveryKey -Name "MyNewGateway" -RegionKey brazilsouth

Creates a new gateway named "MyNewGateway" in the Brazil South region. You can securely store the encrypted recovery key in a file and pass that into Add-DataGatewayCluster without any user interaction.

Parameters

-GatewayName

This is the name of the gateway cluster that will be created. It cannot conflict with any existing gateways on the same tenant.

Type:String
Aliases:Name
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OverwriteExistingGateway

This parameter when set to $true would overwrite the existing gateway configuration on the local machine and configure a new one. The overwritten gateway can still be recovered on another computer.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RecoveryKey

The recovery key is used by the gateway to encrypt/decrypt on-prem credentials. This is also requried to restore the gateway or add a new member to the gateway cluster.

Type:SecureString
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RegionKey

This parameter indicates the Azure region associated with your 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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Void

Notes

This command must be run with a user based credential.