次の方法で共有

Admin - Pipelines GetPipelinesAsAdmin

  • リファレンス
サービス:
Power BI REST APIs
API バージョン:
v1.0

組織のデプロイ パイプラインの一覧を返します。

権限

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

必要なスコープ

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

制限事項

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

GET https://api.powerbi.com/v1.0/myorg/admin/pipelines
省略可能なパラメーターを含む: 
GET https://api.powerbi.com/v1.0/myorg/admin/pipelines?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前 / 必須 型 説明
$expand
 query

string

応答でインラインで展開されるデータ型のコンマ区切りのリストを受け入れます。 users と stages をサポートします。
$filter
 query

string

ブール条件に基づいて結果をフィルター処理します。 この API では、孤立したデプロイ パイプライン のフィルター処理のみがサポートされます。 サポートされていないフィルターは、フィルター処理されていない結果を返します。
$skip
 query

integer (int32)

最初の n 個の結果をスキップします。 top と共に使用して、最初の 5000 を超える結果をフェッチします。
$top
 query

integer (int32)

minimum: 1
maximum: 5000

最初の n 個の結果のみを返します。 このパラメーターは 1 から 5000 の範囲である必要があります。

応答

名前 型 説明
200 OK

AdminPipelines

わかりました

例

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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

要求のサンプル

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

応答のサンプル

状態コード:
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

Object

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

名前 型 説明
description

string

デプロイ パイプラインの説明
displayName

string

デプロイ パイプラインの表示名
id

string (uuid)

デプロイ パイプライン ID
stages

PipelineStage[]

デプロイ パイプライン ステージのコレクション。 $expand が要求で stages に設定されている場合にのみ返されます。
users

PipelineUser[]

デプロイ パイプライン ユーザーのコレクション。 $expand が要求で users に設定されている場合にのみ返されます。

AdminPipelines

Object

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

名前 型 説明
@odata.context

string

OData コンテキスト
value

AdminPipeline[]

デプロイ パイプラインのコレクション

PipelineStage

Object

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

名前 型 説明
order

integer

0 から始まるステージの順序。
workspaceId

string (uuid)

割り当てられたワークスペース ID。 割り当てられたワークスペースがある場合にのみ適用されます。
workspaceName

string

割り当てられたワークスペース名。 割り当てられたワークスペースがあり、ユーザーがワークスペースにアクセスできる場合にのみ適用されます。

PipelineUser

Object

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

名前 型 説明
accessRight

PipelineUserAccessRight

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

string

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

PrincipalType

プリンシパルの種類

PipelineUserAccessRight

列挙

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

値 説明
Admin

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

PrincipalType

列挙

プリンシパルの種類

値 説明
App

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

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

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

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