Add-DataGatewayClusterUser

  • リファレンス
モジュール:
DataGateway

ユーザーと関連するアクセス許可をクラスターに追加する

構文

Add-DataGatewayClusterUser
   [-Scope <PowerBIUserScope>]
   -GatewayClusterId <Guid>
   -PrincipalObjectId <Guid>
   [-AllowedDataSourceTypes <DatasourceType[]>]
   -Role <GatewayPrincipalRole>
   [-RegionKey <String>]
   [<CommonParameters>]

説明

ユーザーと関連するアクセス許可をクラスターに追加する

例

例 1

PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id
PS C:\> $dsTypes = New-Object 'System.Collections.Generic.List[Microsoft.PowerBI.ServiceContracts.Api.DatasourceType]'
PS C:\> $dsTypes.Add([Microsoft.DataMovement.Powershell.GatewayClient.Gateways.Entities.DataSourceType]::Sql)
PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $dsTypes -Role ConnectionCreatorWithReshare

この例では、SQL データソースの種類のゲートウェイ クラスターに ConnectionCreatorWithReshare のロールのユーザー "testUpn@tenant.com" を追加します。

例 2

PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id
PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $null -Role Admin

次の使用例は、すべてのデータソースの種類について、管理の役割のユーザー "adminTestUpn@tenant.com" をゲートウェイ クラスターに追加します。 ロールが AllowedDataSourceTypes 管理者の場合は null にする必要があることに注意してください (すべてのデータソースの種類が許可されていることを意味します)。

例 3

PS C:\> $userToAdd = $(Get-AzADUser -ObjectId "testUpn@tenant.com").Id
PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $null -Role Admin -RegionKey brazilsouth

次の使用例は、すべてのデータソースの種類について、管理の役割のユーザー "adminTestUpn@tenant.com" をゲートウェイ クラスターに追加します。 ロールが AllowedDataSourceTypes 管理者の場合は null にする必要があることに注意してください (すべてのデータソースの種類が許可されていることを意味します)。 このコマンドはブラジル南部リージョンで実行されるため、指定されたゲートウェイ クラスター ID はそのリージョンに存在する必要があります。

例 4

PS C:\> $userToAdd = $(Get-AzADServicePrincipal -ApplicationId DC8F2C49-9087-4B27-966B-3DB5094C2E77).Id
PS C:\> Add-DataGatewayClusterUser -GatewayClusterId DC8F2C49-5731-4B27-966B-3DB5094C2E77 -PrincipalObjectId $userToAdd -AllowedDataSourceTypes $null -Role Admin -RegionKey brazilsouth

この例では、アプリケーション ID DC8F2C49-9087-4B27-966B-3DB5094C2E77 のサービス プリンシパルを、すべてのデータソースの種類のゲートウェイ クラスターに管理の役割で追加します。 詳細については、「 Get-AzADServicePrincipal」を参照してください。 ロールが AllowedDataSourceTypes 管理者の場合は null にする必要があることに注意してください (すべてのデータソースの種類が許可されていることを意味します)。 このコマンドはブラジル南部リージョンで実行されるため、指定されたゲートウェイ クラスター ID はそのリージョンに存在する必要があります。

パラメーター

-AllowedDataSourceTypes

このユーザー/ロールの組み合わせで許可されるデータソース型。 ロールが admin の場合 (すべてのデータソースの種類が許可されていることを意味します) は null にする必要があります。 データ ソースの種類の一覧は、サポートされているデータ ソースに基づいて変更される場合があります。 注: このパラメーターは、PowerApps と Flow にのみ適用されます。

Type:DatasourceType[]
Accepted values:Sql, AnalysisServices, SAPHana, File, Folder, Oracle, Teradata, SharePointList, Web, OData, DB2, MySql, PostgreSql, Sybase, Extension, SAPBW, AzureTables, AzureBlobs, Informix, ODBC, Excel, SharePoint, PubNub, MQ, BizTalk, GoogleAnalytics, CustomHttpApi, Exchange, Facebook, HDInsight, AzureMarketplace, ActiveDirectory, Hdfs, SharePointDocLib, PowerQueryMashup, OleDb, AdoDotNet, R, LOB, Salesforce, CustomConnector, SAPBWMessageServer, AdobeAnalytics, Essbase, AzureDataLakeStorage, SapErp, UIFlow, CDPA, EventHub, Unknown
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GatewayClusterId

ユーザーを追加するゲートウェイ クラスター

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

-PrincipalObjectId

ゲートウェイ クラスターに追加する Azure Active Directory (AAD) プリンシパル オブジェクト ID (つまり、ユーザー ID)

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

-RegionKey

指定したゲートウェイ クラスターに関連付けられている Azure リージョン。 -RegionKey指定しない場合、テナントの既定のリージョンでコマンドが実行されます。 使用可能なリージョン パラメーターの一覧を取得するには、コマンドを Get-DataGatewayRegion 実行します。

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

-Role

クラスター上のこのユーザーに適用するロール。 ユーザーは、管理者、接続作成者 (使用できる) または共有 (Can use + Share) 機能を持つ接続作成者として追加できます。 接続作成者 (Can Use) と Connection Creators with sharing(Can use + Share) 機能は、PowerApps と Flow にのみ適用されます。

Type:GatewayPrincipalRole
Accepted values:Admin, ConnectionCreator, ConnectionCreatorWithReshare
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Scope

コマンドを実行するセキュリティ スコープ。 これにより、テナント/サービス管理者のスコープでこのコマンドを実行しているか、ゲートウェイ 管理

Type:PowerBIUserScope
Accepted values:Individual, Organization
Position:Named
Default value:Individual
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

None

出力

System.Void