Share via

Set-DataGatewayClusterDatasource

Module:
DataGateway Module

Set the properties of the specified Power BI datasource from the specified cluster

Syntax

Default (Default) 

Set-DataGatewayClusterDatasource
    -GatewayClusterId <Guid>
    -GatewayClusterDatasourceId <Guid>
    [-Annotation <String>]
    [-DatasourceName <String>]
    [-SingleSignOnType <String>]
    [<CommonParameters>]

Description

Set the properties of the specified Power BI datasource from the specified cluster

Examples

Example 1

PS C:\> Set-DataGatewayClusterDatasource -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -DatasourceName "New datasource name"

Update the name of the datasource to "New datasource name"

Parameters

-Annotation

Data source description or comments for the data source

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

-DatasourceName

The new name to be set for the data source

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

-GatewayClusterDatasourceId

The data source ID for which properties are to be set up.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DatasourceId, Datasource

Parameter sets

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

-GatewayClusterId

Gateway cluster on which the data source exists

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

-SingleSignOnType

Enables single sign-on for supported data sources. For more information, see Overview of single sign-on (SSO) for on-premises data gateways in Power BI.

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