Set-DataGatewayClusterDatasource

  • Reference
Module:
DataGateway

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

Syntax

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

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

-DatasourceName

The new name to be set for the data source

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

-GatewayClusterDatasourceId

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

Type:Guid
Aliases:DatasourceId, Datasource
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-GatewayClusterId

Gateway cluster on which the data source exists

Type:Guid
Aliases:Cluster, Id
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

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

Inputs

None

Outputs

System.Void