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 參數

名稱	位於	必要	類型	Description
operationId	path	True	string uuid	作業識別碼
pipelineId	path	True	string uuid	部署管線識別碼

回應

名稱	類型	Description
200 OK	PipelineOperation	確定

範例

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"
  }
}

定義

名稱	Description
DeploymentError	部署步驟的錯誤詳細資料
DeploymentExecutionPlan	部署執行計畫
DeploymentExecutionStep	部署執行步驟
DeploymentExecutionStepPreDeploymentDiffState	這是部署之前，目標階段中專案的新專案、不同或完全相同的專案。
DeploymentSourceAndTarget	來源和目標專案
DeploymentStepType	部署步驟的類型
PipelineOperation	Power BI 部署管線作業
PipelineOperationNote	描述部署的附注。
PipelineOperationStatus	管線作業狀態
PipelineOperationType	作業類型
PipelineOperationUser	執行管線作業的使用者或服務主體。
PreDeploymentDiffInformation	部署之前，新、不同且相同的已部署專案數量。
PrincipalType	主體類型

DeploymentError

部署步驟的錯誤詳細資料

名稱	類型	Description
errorCode	string	錯誤碼
errorDetails	string	其他錯誤詳細資料

DeploymentExecutionPlan

部署執行計畫

名稱	類型	Description
steps	DeploymentExecutionStep[]	執行計畫步驟的集合

DeploymentExecutionStep

部署執行步驟

名稱	類型	Description
error	DeploymentError	錯誤詳細資料。只有在管線作業失敗時才適用。
index	integer	步驟索引
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	這是部署之前，目標階段中專案的新專案、不同或完全相同的專案。
sourceAndTarget	DeploymentSourceAndTarget	步驟的來源和目標專案
status	PipelineOperationStatus	管線作業的狀態
type	DeploymentStepType	部署步驟的類型

DeploymentExecutionStepPreDeploymentDiffState

這是部署之前，目標階段中專案的新專案、不同或完全相同的專案。

名稱	類型	Description
Different	string	在部署之前，來源階段中的專案與目標階段中的專案不同。
New	string	目標階段中不存在的新部署專案。
NoDifference	string	在部署之前，來源階段中的專案與目標階段中的專案相同。

DeploymentSourceAndTarget

來源和目標專案

名稱	類型	Description
source	string	從來源階段部署的 Power BI 專案識別碼
sourceDisplayName	string	從來源階段部署的 Power BI 專案的顯示名稱
target	string	將在目標階段中覆寫之 Power BI 專案的識別碼。僅適用于覆寫 Power BI 專案時。
targetDisplayName	string	將在目標階段中覆寫的 Power BI 專案名稱。僅適用于覆寫 Power BI 專案時。
type	string	將在目標階段中覆寫的 Power BI 專案類型。僅適用于覆寫 Power BI 專案時。

DeploymentStepType

部署步驟的類型

名稱	類型	Description
DashboardDeployment	string	部署單一儀表板的步驟
DataflowDeployment	string	部署單一資料流程的步驟
DatamartDeployment	string	部署單一資料超市的步驟
DatasetDeployment	string	部署單一資料集的步驟
ReportDeployment	string	部署單一報表的步驟

PipelineOperation

Power BI 部署管線作業

名稱	類型	Description
executionEndTime	string	作業結束的日期和時間
executionPlan	DeploymentExecutionPlan	部署執行計畫。僅適用于單一管線作業。
executionStartTime	string	作業啟動的日期和時間
id	string	作業識別碼
lastUpdatedTime	string	上次更新作業的日期和時間
note	PipelineOperationNote	代表作業描述的附注。
performedBy	PipelineOperationUser	執行管線作業的使用者或服務主體。
preDeploymentDiffInformation	PreDeploymentDiffInformation	部署之前，來源階段中已部署的專案數量，與目標階段中的專案相同或不同。
sourceStageOrder	integer	來源管線部署階段的數值識別碼。開發 (0) 、測試 (1) 、生產 (2) 。
status	PipelineOperationStatus	管線作業狀態
targetStageOrder	integer	目標管線部署階段的數值識別碼。開發 (0) 、測試 (1) 、生產 (2) 。
type	PipelineOperationType	作業類型

PipelineOperationNote

描述部署的附注。

名稱	類型	Description
content	string	描述部署的文字。
isTruncated	boolean	指出附注是否不完整。 True 是表示只會傳回附注的一部分。 False，附注已完成。

PipelineOperationStatus

管線作業狀態

名稱	類型	Description
Executing	string	正在執行的作業
Failed	string	作業失敗
NotStarted	string	作業未啟動
Succeeded	string	作業成功

PipelineOperationType

作業類型

名稱	類型	Description
Deploy	string	在階段之間部署內容

PipelineOperationUser

執行管線作業的使用者或服務主體。

名稱	類型	Description
principalObjectID	string	執行部署之服務主體的識別碼。
principalType	PrincipalType	執行部署的使用者類型。
userPrincipalName	string	執行部署之使用者的 UPN。

PreDeploymentDiffInformation

部署之前，新、不同且相同的已部署專案數量。

名稱	類型	Description
differentArtifactsCount	integer	部署之前，來源和目標階段之間有差異的已部署專案數目。
newArtifactsCount	integer	部署到目標階段的新專案數目。
noDifferenceArtifactsCount	integer	在部署之前，來源和目標階段中相同的已部署專案數目。

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。用於整個組織層級存取。
User	string	使用者主體類型

共用方式為