Pipelines - Get Pipeline

Service:

Power BI REST APIs

API Version:

v1.0

指定したデプロイ パイプラインを返します。

必要なスコープ

Pipeline.ReadWrite.All または Pipeline.Read.All

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

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}?$expand={$expand}

URI パラメーター

名前	/	必須	型	説明
pipelineId	path	True	string uuid	デプロイ パイプライン ID
$expand	query		string	応答でインライン展開されるデータ型のコンマ区切りのリストを受け入れます。 stagesをサポートします。

応答

名前	型	説明
200 OK	Pipeline	OK

例

Get a deployment pipeline with its 'stages' expanded example

Get a deployment pipeline without its 'stages' expanded example

Get a deployment pipeline with its 'stages' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824?$expand=stages

Sample Response

Status code:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline",
  "description": "My deployment pipeline",
  "stages": [
    {
      "order": 0,
      "workspaceId": "4de5bcc4-2c88-4efe-b827-4ee7b289b496",
      "workspaceName": "Workspace-Development"
    },
    {
      "order": 1,
      "workspaceId": "44b499cf-1eeb-45e2-9ada-63b6ec9d516e"
    },
    {
      "order": 2
    }
  ]
}

Get a deployment pipeline without its 'stages' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824

Sample Response

Status code:

200

{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Marketing Deployment Pipeline",
  "description": "Power BI deployment pipeline to manage marketing reports"
}

定義

名前	説明
Pipeline	Power BI パイプライン
PipelineStage	Power BI デプロイ パイプライン ステージ

Pipeline

Power BI パイプライン

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

PipelineStage

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

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