Share via

Set-DataGatewayCluster

Module:
DataGateway Module

Set attributes of an existing gateway cluster

Syntax

Default (Default) 

Set-DataGatewayCluster
    [-Scope <PowerBIUserScope>]
    -GatewayClusterId <Guid>
    [-Name <String>]
    [-Department <String>]
    [-Description <String>]
    [-ContactInformation <String>]
    [-AllowCloudDatasourceRefresh <Boolean>]
    [-AllowCustomConnectors <Boolean>]
    [-LoadBalancingSelectorType <String>]
    [-RegionKey <String>]
    [<CommonParameters>]

Description

Set attributes of an existing gateway cluster

Examples

Example 1

PS C:\> Set-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -AllowCloudDatasourceRefresh $true

Allow Power BI cloud datasource refresh on the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77

Example 2

PS C:\> Set-DataGatewayCluster -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -AllowCloudDatasourceRefresh $true -RegionKey brazilsouth

Allow Power BI cloud datasource refresh on the cluster with ID DC8F2C49-5731-4B27-966B-3DB5094C2E77 This command is run in the Brazil south region, so the gateway cluster ID provided should be in that region.

Parameters

-AllowCloudDatasourceRefresh

If set to true, Power BI cloud datasource refresh is allowed on this cluster.

Parameter properties

Type:Boolean
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

-AllowCustomConnectors

If set to true, Power BI custom connector based refreshes are allowed on this gateway cluster.

Parameter properties

Type:Boolean
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

-ContactInformation

Contact information for this gateway cluster.

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

-Department

Department attribute for this gateway cluster

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

-Description

Description of this gateway cluster.

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

-GatewayClusterId

Gateway cluster for which attributes need to be updated

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Cluster, Id

Parameter sets

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

-LoadBalancingSelectorType

Load-balancing type for this cluster. Values could either be failover or random which would mean the following: failover = roundrobin random = random If either nothing was passed or anything else was passed, it would be roundrobin

Parameter properties

Type:String
Default value:None
Accepted values:Failover, Random
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

-Name

Name of the gateway cluster.

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

-RegionKey

The region associated with the specified gateway cluster. Not providing a -RegionKey will run the command in the default region for your tenant. To get the list of available region parameters run the Get-DataGatewayRegion command

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

-Scope

Security Scope to run the command. This would determine if you are running this command in the scope of a Tenant/Service admin or a Gateway Admin

Parameter properties

Type:PowerBIUserScope
Default value:Individual
Accepted values:Individual, Organization
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