Share via


Add-DataGatewayClusterDatasourceUser

Grants a user permission to use the specified Power BI datasource.

Syntax

PrincipalObjectIdScenario

Add-DataGatewayClusterDatasourceUser
    -GatewayClusterId <Guid>
    -GatewayClusterDatasourceId <Guid>
    -DatasourceUserAccessRight <DatasourceUserAccessRight>
    -Identifier <Guid>
    [-UserEmailAddress <String>]
    [<CommonParameters>]

EmailAddressScenario

Add-DataGatewayClusterDatasourceUser
    -GatewayClusterId <Guid>
    -GatewayClusterDatasourceId <Guid>
    -DatasourceUserAccessRight <DatasourceUserAccessRight>
    -UserEmailAddress <String>
    [-Identifier <Guid>]
    [<CommonParameters>]

Description

Grants a user permission to use the specified Power BI datasource.

Examples

Example 1

PS C:\> Add-DataGatewayClusterDatasourceUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -DatasourceUserAccessRight Read -UserEmailAddress testEmail@tenant.com

Grants read access to 'testUpn@tenant.com' for the datasource.

Example 2

PS C:\> Add-DataGatewayClusterDatasourceUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -GatewayClusterDatasourceId 64C574B7-86C6-4560-B710-40AC18990804 -DatasourceUserAccessRight Read -Identifier 8F4FD111-57EE-4E99-B65C-3DC0EFB1479D

Grants read access to principal with the given object id for the datasource.

Parameters

-DatasourceUserAccessRight

User permissions for this data source. It could either be Read or ReadOverrideEffectiveIdentity. Read permissions provides read access to the data source. ReadOverrideEffectiveIdentity indicates that the user can override effective identity for Power BI Embedded. For more information, see DatasourceUserAccessRight.

Parameter properties

Type:DatasourceUserAccessRight
Default value:None
Accepted values:Read, ReadOverrideEffectiveIdentity
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

-GatewayClusterDatasourceId

Data source to which the user is granted permissions for.

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 to which the data source belongs.

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

-Identifier

Principal objectId of the user/group/service principal.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ObjectId

Parameter sets

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

-UserEmailAddress

Email address of the user to be added

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:User, EmailAddress

Parameter sets

PrincipalObjectIdScenario
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