Pipelines - Update Pipeline User

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

指定したデプロイ パイプラインに対するユーザーのアクセス許可を付与します。

必要なスコープ

Pipeline.ReadWrite.All

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

URI パラメーター

名前 / 必須 型 説明
pipelineId
 path True

string

uuid

デプロイ パイプライン ID

要求本文

名前 必須 型 説明
identifier True

string

プリンシパルの種類 Userの場合は、 UPN を指定します。 それ以外の場合は、プリンシパルの オブジェクト ID を 指定します。
principalType True

PrincipalType

プリンシパルの種類
accessRight

PipelineUserAccessRight

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

応答

名前 型 説明
200 OK

OK

例

Add a group to a deployment pipeline example
Add a service principal to a deployment pipeline example
Add a user to a deployment pipeline example

Add a group to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "accessRight": "Admin",
  "principalType": "Group"
}

Sample Response

Status code:
200

Add a service principal to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
  "accessRight": "Admin",
  "principalType": "App"
}

Sample Response

Status code:
200

Add a user to a deployment pipeline example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "john@contoso.com",
  "accessRight": "Admin",
  "principalType": "User"
}

Sample Response

Status code:
200

定義

名前 説明
PipelineUser

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

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

プリンシパルの種類

PipelineUser

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

名前 型 説明
accessRight

PipelineUserAccessRight

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

string

プリンシパルの種類 Userの場合は、 UPN を指定します。 それ以外の場合は、プリンシパルの オブジェクト ID を 指定します。
principalType

PrincipalType

プリンシパルの種類

PipelineUserAccessRight

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

名前 型 説明
Admin

string

デプロイ パイプラインに対する管理者権限を付与します

PrincipalType

プリンシパルの種類

名前 型 説明
App

string

サービス プリンシパルの種類
Group

string

グループ プリンシパルの種類
None

string

プリンシパルの種類はありません。 組織全体レベルのアクセスに使用します。
User

string

ユーザー プリンシパルの種類