Admin - Pipelines GetPipelinesAsAdmin

リファレンス

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

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前	/	型	説明
$expand	query	string	コンマ区切りのデータ型の一覧を受け入れます。これは、応答でインラインで展開されます。と `stages`をサポートします`users`。
$filter	query	string	ブール条件に基づいて結果をフィルター処理します。この API では、孤立したデプロイパイプラインのフィルター処理のみがサポートされます。サポートされていないフィルターでは、フィルター処理されていない結果が返されます。
$skip	query	integer int32	最初の n 個の結果をスキップします。 top でを使用して、最初の 5000 を超える結果をフェッチします。
$top	query	integer int32	最初の n 個の結果のみを返します。このパラメーターは、1 から 5000 の範囲である必要があります。

応答

名前	型	説明
200 OK	AdminPipelines	OK

例

Get deployment pipelines example

Get deployment pipelines with their 'stages' expanded example

Get deployment pipelines with their 'users' expanded example

Get orphaned deployment pipelines example

Get deployment pipelines example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports"
    }
  ]
}

Get deployment pipelines with their 'stages' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=stages&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "stages": [
        {
          "order": "0",
          "workspaceId": "5dba60b0-d9a7-42a3-b12c-6d9d51e7739a",
          "workspaceName": "SQlAzure-Refresh"
        },
        {
          "order": "1",
          "workspaceId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "workspaceName": "SQlAzure-Refresh[Test]"
        },
        {
          "order": "2"
        }
      ]
    }
  ]
}

Get deployment pipelines with their 'users' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports",
      "users": [
        {
          "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"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

Get orphaned deployment pipelines example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand=users&$filter=(not users/any())&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "displayName": "Financing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage financing reports",
      "users": []
    }
  ]
}

定義

名前	説明
AdminPipeline	ユーザー API によって返される Power BI パイプライン
AdminPipelines	Power BI デプロイパイプラインのコレクションの OData 応答ラッパー
PipelineStage	Power BI デプロイパイプラインステージ
PipelineUser	デプロイパイプラインの Power BI ユーザーアクセス権エントリ
PipelineUserAccessRight	必須です。ユーザーがデプロイパイプラインに対して持っているアクセス権。
PrincipalType	プリンシパルの種類

AdminPipeline

ユーザー API によって返される Power BI パイプライン

名前	型	説明
description	string	デプロイパイプラインの説明
displayName	string	デプロイパイプラインの表示名
id	string	デプロイパイプライン ID
stages	PipelineStage[]	デプロイパイプラインステージのコレクション。が要求でに`stages`設定されている場合`$expand`にのみ返されます。
users	PipelineUser[]	デプロイパイプラインユーザーのコレクション。が要求でに`users`設定されている場合`$expand`にのみ返されます。

AdminPipelines

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

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

PipelineStage

Power BI デプロイパイプラインステージ

名前	型	説明
order	integer	0 から始まるステージの順序。
workspaceId	string	割り当てられたワークスペース ID。ワークスペースが割り当てられている場合にのみ適用されます。
workspaceName	string	割り当てられたワークスペース名。割り当てられたワークスペースがあり、ユーザーがワークスペースにアクセスできる場合にのみ適用されます。

PipelineUser

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

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

PipelineUserAccessRight

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

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

PrincipalType

プリンシパルの種類

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

Share via

Admin - Pipelines GetPipelinesAsAdmin

アクセス許可

必要なスコープ

制限事項

URI パラメーター

応答

例

Get deployment pipelines example

Sample Request

Sample Response

Get deployment pipelines with their 'stages' expanded example

Sample Request

Sample Response

Get deployment pipelines with their 'users' expanded example

Sample Request

Sample Response

Get orphaned deployment pipelines example

Sample Request

Sample Response

定義

AdminPipeline

AdminPipelines

PipelineStage

PipelineUser

PipelineUserAccessRight

PrincipalType

その他のリソース