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	确定

示例

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	部署单个仪表板的步骤
DataflowDeployment	string	部署单个数据流的步骤
DatamartDeployment	string	部署单个数据市场的步骤
DatasetDeployment	string	部署单个数据集的步骤
ReportDeployment	string	部署单个报表的步骤

PipelineOperation

Power BI 部署管道操作

名称	类型	说明
executionEndTime	string	操作结束的日期和时间
executionPlan	DeploymentExecutionPlan	部署执行计划。仅适用于单个管道操作。
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	用户主体类型

通过