次の方法で共有

Pipelines - Update Pipeline

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

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

必要なスコープ

Pipeline.ReadWrite.All

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

URI パラメーター

名前 / 必須 型 説明
pipelineId
 path True

string (uuid)

デプロイ パイプライン ID

要求本文

名前 型 説明
description

string

maxLength: 1024

デプロイ パイプラインの更新された説明
displayName

string

maxLength: 256

デプロイ パイプラインの更新された表示名

応答

名前 型 説明
200 OK

Pipeline

わかりました

例

Update a deployment pipeline example

要求のサンプル

PATCH https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824
要求本文
{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

応答のサンプル

状態コード:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

定義

名前 説明
Pipeline

Power BI パイプライン
PipelineStage

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

既存のデプロイ パイプラインを更新する要求。 更新された表示名または説明が必要です。

Pipeline

Object

Power BI パイプライン

名前 型 説明
description

string

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

string

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

string (uuid)

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

PipelineStage[]

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

PipelineStage

Object

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

名前 型 説明
order

integer

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

string (uuid)

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

string

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

UpdatePipelineRequest

Object

既存のデプロイ パイプラインを更新する要求。 更新された表示名または説明が必要です。

名前 型 説明
description

string

maxLength: 1024

デプロイ パイプラインの更新された説明
displayName

string

maxLength: 256

デプロイ パイプラインの更新された表示名