Admin - Pipelines GetPipelineUsersAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したデプロイパイプラインにアクセスできるユーザーの一覧を返します。

アクセス許可

ユーザーは管理者権限を持っているか、サービスプリンシパルを使用して認証する必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

制限事項

1 時間あたり最大 200 件の要求。

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines/{pipelineId}/users

URI パラメーター

名前	/	必須	型	説明
pipelineId	path	True	string uuid	デプロイパイプライン ID

応答

名前	型	説明
200 OK	PipelineUsers	OK

例

Get users of a deployment pipeline example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users

Sample Response

Status code:: 200

{
  "value": [
    {
      "identifier": "john@contoso.com",
      "accessRight": "Admin",
      "principalType": "User"
    },
    {
      "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
      "accessRight": "Admin",
      "principalType": "Group"
    },
    {
      "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
      "accessRight": "Admin",
      "principalType": "App"
    }
  ]
}

定義

名前	説明
PipelineUser	デプロイパイプラインの Power BI ユーザーアクセス権エントリ
PipelineUserAccessRight	必須です。ユーザーがデプロイパイプラインに対して持つアクセス権。
PipelineUsers	Power BI デプロイパイプラインユーザーのコレクションの OData 応答ラッパー
PrincipalType	プリンシパルの種類

PipelineUser

デプロイパイプラインの Power BI ユーザーアクセス権エントリ

名前	型	説明
accessRight	PipelineUserAccessRight	必須です。ユーザーがデプロイパイプラインに対して持つアクセス権。
identifier	string	プリンシパルの種類 `User`の場合は、 UPN を指定します。それ以外の場合は、プリンシパルのオブジェクト ID を指定します。
principalType	PrincipalType	プリンシパルの種類

PipelineUserAccessRight

必須です。ユーザーがデプロイパイプラインに対して持つアクセス権。

名前	型	説明
Admin	string	デプロイパイプラインに管理者権限を付与する

PipelineUsers

Power BI デプロイパイプラインユーザーのコレクションの OData 応答ラッパー

名前	型	説明
odata.context	string	OData コンテキスト
value	PipelineUser[]	デプロイパイプラインユーザーのコレクション

PrincipalType

プリンシパルの種類

名前	型	説明
App	string	サービスプリンシパルの種類
Group	string	グループプリンシパルの種類
None	string	プリンシパルの種類はありません。組織全体レベルのアクセスに使用します。
User	string	ユーザープリンシパルの種類

Share via