Pipelines - Get Pipeline Operation

リファレンス

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}/operations/{operationId}

URI パラメーター

名前	/	必須	型	説明
operationId	path	True	string uuid	操作 ID
pipelineId	path	True	string uuid	デプロイパイプライン ID

応答

名前	型	説明
200 OK	PipelineOperation	OK

例

Get a pipeline operation example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

Sample Response

Status code:: 200

{
  "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
  "type": "Deploy",
  "status": "Succeeded",
  "lastUpdatedTime": "2020-12-13T09:26:43.153",
  "executionStartTime": "2020-12-13T09:25:43.153Z",
  "executionEndTime": "2020-12-13T09:26:43.153Z",
  "sourceStageOrder": 0,
  "targetStageOrder": 1,
  "executionPlan": {
    "Steps": [
      {
        "index": 0,
        "type": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceDisplayName": "Source dataflow",
          "type": "dataflow"
        }
      },
      {
        "index": 1,
        "type": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceDisplayName": "Source datamart",
          "type": "datamart"
        }
      },
      {
        "index": 2,
        "type": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "source": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceDisplayName": "Source dataset",
          "target": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetDisplayName": "Target dataset",
          "type": "dataset"
        }
      },
      {
        "index": 3,
        "type": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "source": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceDisplayName": "Source report",
          "target": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetDisplayName": "Target report",
          "type": "report"
        }
      },
      {
        "index": 4,
        "type": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceDisplayName": "Source dashboard",
          "type": "dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note",
    "isTruncated": false
  },
  "preDeploymentDiffInformation": {
    "newArtifactsCount": 3,
    "differentArtifactsCount": 1,
    "noDifferenceArtifactsCount": 1
  },
  "performedBy": {
    "userPrincipalName": "john@contoso.com",
    "principalType": "User"
  }
}

定義

名前	説明
DeploymentError	デプロイ手順のエラーの詳細
DeploymentExecutionPlan	デプロイ実行プラン
DeploymentExecutionStep	デプロイの実行手順
DeploymentExecutionStepPreDeploymentDiffState	デプロイ前のターゲットステージの項目とは異なる、または同一の新しい項目です。
DeploymentSourceAndTarget	ソースアイテムとターゲットアイテム
DeploymentStepType	デプロイ手順の種類
PipelineOperation	Power BI デプロイパイプライン操作
PipelineOperationNote	デプロイについて説明するメモ。
PipelineOperationStatus	パイプライン操作の状態
PipelineOperationType	操作の種類
PipelineOperationUser	パイプライン操作を実行したユーザーまたはサービスプリンシパル。
PreDeploymentDiffInformation	デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの量。
PrincipalType	プリンシパルの種類

DeploymentError

デプロイ手順のエラーの詳細

名前	型	説明
errorCode	string	エラーコード
errorDetails	string	その他のエラーの詳細

DeploymentExecutionPlan

デプロイ実行プラン

名前	型	説明
steps	DeploymentExecutionStep[]	実行プランステップのコレクション

DeploymentExecutionStep

デプロイの実行手順

名前	型	説明
error	DeploymentError	エラーの詳細です。パイプライン操作が失敗した場合にのみ適用されます。
index	integer	ステップインデックス
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	デプロイ前のターゲットステージの項目とは異なる、または同一の新しい項目です。
sourceAndTarget	DeploymentSourceAndTarget	ステップのソース項目とターゲット項目
status	PipelineOperationStatus	パイプライン操作の状態
type	DeploymentStepType	デプロイ手順の種類

DeploymentExecutionStepPreDeploymentDiffState

デプロイ前のターゲットステージの項目とは異なる、または同一の新しい項目です。

名前	型	説明
Different	string	デプロイ前は、ソースステージの項目がターゲットステージの項目と同じではありませんでした。
New	string	ターゲットステージに存在しない新しいデプロイ済みアイテム。
NoDifference	string	デプロイ前のソースステージの項目は、ターゲットステージの項目と同じでした。

DeploymentSourceAndTarget

ソースアイテムとターゲットアイテム

名前	型	説明
source	string	ソースステージからデプロイされる Power BI 項目の ID
sourceDisplayName	string	ソースステージからデプロイされた Power BI 項目の表示名
target	string	ターゲットステージで上書きされる Power BI 項目の ID。 Power BI アイテムを上書きする場合にのみ適用されます。
targetDisplayName	string	ターゲットステージで上書きされる Power BI 項目の名前。 Power BI アイテムを上書きする場合にのみ適用されます。
type	string	ターゲットステージで上書きされる Power BI 項目の種類。 Power BI アイテムを上書きする場合にのみ適用されます。

DeploymentStepType

デプロイ手順の種類

名前	型	説明
DashboardDeployment	string	1 つのダッシュボードをデプロイするための手順
DataflowDeployment	string	1 つのデータフローをデプロイするための手順
DatamartDeployment	string	1 つのデータマートをデプロイするための手順
DatasetDeployment	string	1 つのデータセットをデプロイするための手順
ReportDeployment	string	1 つのレポートを展開する手順

PipelineOperation

Power BI デプロイパイプライン操作

名前	型	説明
executionEndTime	string	操作が終了した日時
executionPlan	DeploymentExecutionPlan	デプロイ実行プラン。 1 つのパイプライン操作にのみ適用されます。
executionStartTime	string	操作が開始された日時
id	string	操作 ID
lastUpdatedTime	string	操作が最後に更新された日時
note	PipelineOperationNote	操作の説明を表すメモ。
performedBy	PipelineOperationUser	パイプライン操作を実行したユーザーまたはサービスプリンシパル。
preDeploymentDiffInformation	PreDeploymentDiffInformation	デプロイ前のソースステージ内のデプロイ済みアイテムの量。ターゲットステージの項目と同じか異なる新しいアイテムです。
sourceStageOrder	integer	ソースパイプラインデプロイステージの数値識別子。開発 (0)、テスト (1)、運用 (2)。
status	PipelineOperationStatus	パイプライン操作の状態
targetStageOrder	integer	ターゲットパイプラインデプロイステージの数値識別子。開発 (0)、テスト (1)、運用 (2)。
type	PipelineOperationType	操作の種類

PipelineOperationNote

デプロイについて説明するメモ。

名前	型	説明
content	string	デプロイを説明するテキスト。
isTruncated	boolean	メモが不完全かどうかを示します。 True の場合、ノートの一部のみが返されます。 False、メモは完了です。

PipelineOperationStatus

パイプライン操作の状態

名前	型	説明
Executing	string	操作の実行
Failed	string	操作に失敗しました
NotStarted	string	操作が開始されていません
Succeeded	string	操作が成功しました

PipelineOperationType

操作の種類

名前	型	説明
Deploy	string	ステージ間でコンテンツを展開する

PipelineOperationUser

パイプライン操作を実行したユーザーまたはサービスプリンシパル。

名前	型	説明
principalObjectID	string	デプロイを実行したサービスプリンシパルの ID。
principalType	PrincipalType	デプロイを実行したユーザーの種類。
userPrincipalName	string	デプロイを実行したユーザーの UPN。

PreDeploymentDiffInformation

デプロイ前の新しい、異なる、同一のデプロイ済みアイテムの量。

名前	型	説明
differentArtifactsCount	integer	デプロイ前のソースステージとターゲットステージの違いを持つデプロイ済みアイテムの数。
newArtifactsCount	integer	ターゲットステージにデプロイされた新しい項目の数。
noDifferenceArtifactsCount	integer	デプロイ前のソースステージとターゲットステージ内の同一のデプロイ済みアイテムの数。

PrincipalType

プリンシパルの種類

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

次の方法で共有