Add-DataGatewayCluster

Module:

DataGateway Module

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

Syntax

Default (Default)

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.

Example 3

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 -OverwriteExistingGateway

Creates a new gateway named "MyNewGateway" in the Brazil South region and overwrites the gateway configuration existing on that local machine and configures the new one. 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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Name

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OverwriteExistingGateway

When this parameter is set it 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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	SecureString
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Void

Notes

This command must be run with a user based credential.