Add-DataGatewayClusterUser
ユーザーと関連する権限をクラスターに追加する
構文
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この例では、ConnectionCreatorWithReshare のロールのユーザー "testUpn@tenant.com" を SQL データソースタイプのゲートウェイクラスターに追加します。
例 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" をすべてのデータソース タイプのゲートウェイ クラスターに追加します。
ロールが admin の場合、 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" をすべてのデータソース タイプのゲートウェイ クラスターに追加します。
ロールが admin の場合、 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」を参照してください。 ロールが admin の場合、 AllowedDataSourceTypes は null である必要があることに注意してください (これは、すべてのデータソースの種類が許可されていることを意味します)。 このコマンドはブラジル南部リージョンで実行されるため、指定されたゲートウェイクラスター ID はそのリージョンにある必要があります。
パラメーター
-AllowedDataSourceTypes
このユーザー/ロールの組み合わせで許可されるデータソース・タイプ。 ロールが admin の場合、これは null である必要があります (すべてのデータソースの種類が許可されていることを意味します)。 データソースの種類のリストは、サポートされているデータソースに基づいて変更される場合があります。 注: このパラメーターは、PowerApps と Flow にのみ適用されます。
| 型: | DatasourceType[] |
| 指定可能な値: | 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 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-GatewayClusterId
ユーザーを追加する必要があるゲートウェイ クラスター
| 型: | Guid |
| Aliases: | Cluster, Id |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PrincipalObjectId
ゲートウェイ クラスターに追加する Azure Active Directory (AAD) プリンシパル オブジェクト ID (つまり、ユーザー ID)
| 型: | Guid |
| Aliases: | User |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RegionKey
指定したゲートウェイ クラスターに関連付けられている Azure リージョン。
-RegionKeyを指定しないと、テナントの既定のリージョンでコマンドが実行されます。
使用可能なリージョン・パラメータのリストを取得するには、 Get-DataGatewayRegion コマンドを実行します
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Role
クラスター上のこのユーザーに適用するロール。 ユーザーは、管理者、接続作成者(使用可能)、または共有機能を持つ接続作成者(使用可能+共有)として追加できます。 接続作成者 (使用可) と共有接続作成者 (使用可 + 共有) 機能は、PowerApps と Flow にのみ適用されます。
| 型: | GatewayPrincipalRole |
| 指定可能な値: | Admin, ConnectionCreator, ConnectionCreatorWithReshare |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Scope
コマンドを実行するセキュリティ スコープ。 これにより、このコマンドをテナント/サービス管理者のスコープで実行しているか、ゲートウェイ管理者のスコープで実行しているかが判断されます
| 型: | PowerBIUserScope |
| 指定可能な値: | Individual, Organization |
| 配置: | Named |
| 規定値: | Individual |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
出力
System.Void