Set-DataGatewayCluster
Set attributes of an existing gateway cluster
Syntax
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 $trueAllow 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 brazilsouthAllow 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowCustomConnectors
If set to true, Power BI custom connector based refreshes are allowed on this gateway cluster.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContactInformation
Contact information for this gateway cluster.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Department
Department attribute for this gateway cluster
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Description of this gateway cluster.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GatewayClusterId
Gateway cluster for which attributes need to be updated
| Type: | Guid |
| Aliases: | Cluster, Id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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
| Type: | String |
| Accepted values: | Failover, Random |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Name of the gateway cluster.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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
| Type: | PowerBIUserScope |
| Accepted values: | Individual, Organization |
| Position: | Named |
| Default value: | Individual |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
System.Void