Pipelines - Get Pipeline Operation

参考

服务:: Power BI REST APIs

API 版本:: 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

示例请求

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

示例响应

状态代码:: 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

Object

部署步骤的错误详细信息

名称	类型	说明
errorCode	string	错误代码
errorDetails	string	其他错误详细信息

DeploymentExecutionPlan

Object

部署执行计划

名称	类型	说明
steps	DeploymentExecutionStep[]	执行计划步骤的集合

DeploymentExecutionStep

Object

部署执行步骤

名称	类型	说明
error	DeploymentError	错误详细信息。仅当管道作失败时适用。
index	integer	步骤索引
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	是部署前目标阶段中项的新项、不同项或相同项。
sourceAndTarget	DeploymentSourceAndTarget	步骤的源项和目标项
status	PipelineOperationStatus	管道作的状态
type	DeploymentStepType	部署步骤的类型

DeploymentExecutionStepPreDeploymentDiffState

枚举

是部署前目标阶段中项的新项、不同项或相同项。

值	说明
Different	在部署之前，源阶段中的项与目标阶段中的项不同。
New	目标阶段中不存在的新部署项。
NoDifference	在部署之前，源阶段中的项与目标阶段中的项相同。

DeploymentSourceAndTarget

Object

源项和目标项

名称	类型	说明
source	string (uuid)	从源阶段部署的 Power BI 项的 ID
sourceDisplayName	string	从源阶段部署的 Power BI 项的显示名称
target	string (uuid)	将在目标阶段覆盖的 Power BI 项的 ID。仅当覆盖 Power BI 项时适用。
targetDisplayName	string	将在目标阶段覆盖的 Power BI 项的名称。仅当覆盖 Power BI 项时适用。
type	string	将在目标阶段覆盖的 Power BI 项的类型。仅当覆盖 Power BI 项时适用。

DeploymentStepType

枚举

部署步骤的类型

值	说明
DashboardDeployment	部署单个仪表板的步骤
DataflowDeployment	部署单个数据流的步骤
DatamartDeployment	部署单个 Datamart 的步骤
DatasetDeployment	部署单个数据集的步骤
ReportDeployment	部署单个报表的步骤

PipelineOperation

Object

Power BI 部署管道作

名称	类型	说明
executionEndTime	string (date-time)	作结束的日期和时间
executionPlan	DeploymentExecutionPlan	部署执行计划。仅适用于单个管道作。
executionStartTime	string (date-time)	作启动的日期和时间
id	string (uuid)	作 ID
lastUpdatedTime	string (date-time)	上次更新作的日期和时间
note	PipelineOperationNote	表示作说明的注释。
performedBy	PipelineOperationUser	执行管道作的用户或服务主体。
preDeploymentDiffInformation	PreDeploymentDiffInformation	在部署之前，源阶段中已部署的项量（与目标阶段中的项相同或不同）。
sourceStageOrder	integer	源管道部署阶段的数字标识符。开发（0）、测试（1）、生产（2）。
status	PipelineOperationStatus	管道作状态
targetStageOrder	integer	目标管道部署阶段的数字标识符。开发（0）、测试（1）、生产（2）。
type	PipelineOperationType	作类型

PipelineOperationNote

Object

描述部署的注释。

名称	类型	说明
content	string	描述部署的文本。
isTruncated	boolean	指示注释是否不完整。如此，只返回注释的一部分。 False，便笺已完成。

PipelineOperationStatus

枚举

管道作状态

值	说明
Executing	正在执行的作
Failed	操作失败
NotStarted	作未启动
Succeeded	操作成功

PipelineOperationType

枚举

作类型

值	说明
Deploy	在各个阶段之间部署内容

PipelineOperationUser

Object

执行管道作的用户或服务主体。

名称	类型	说明
principalObjectID	string (uuid)	执行部署的服务主体的 ID。
principalType	PrincipalType	执行部署的用户的类型。
userPrincipalName	string	执行部署的用户的 UPN。

PreDeploymentDiffInformation

Object

部署前新、不同和相同的已部署项的数量。

名称	类型	说明
differentArtifactsCount	integer	在部署之前，源阶段和目标阶段之间存在差异的已部署项数。
newArtifactsCount	integer	部署到目标阶段的新项数。
noDifferenceArtifactsCount	integer	在部署之前，源阶段和目标阶段中相同的已部署项数。

PrincipalType

枚举

主体类型

值	说明
App	服务主体类型
Group	组主体类型
None	无主体类型。用于整个组织级别的访问。
User	用户主体类型

通过

Pipelines - Get Pipeline Operation

所需范围

URI 参数

响应

示例

Get a pipeline operation example

示例请求

示例响应

定义

DeploymentError

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentExecutionStepPreDeploymentDiffState

DeploymentSourceAndTarget

DeploymentStepType

PipelineOperation

PipelineOperationNote

PipelineOperationStatus

PipelineOperationType

PipelineOperationUser

PreDeploymentDiffInformation

PrincipalType

其他资源