通过

Pipelines - Get Pipeline Operations

  • 参考
服务:
Power BI REST APIs
API 版本:
v1.0

返回对指定部署管道执行的最多 20 个最新部署操作的列表。

所需范围

Pipeline.ReadWrite.All 或 Pipeline.Read.All

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

URI 参数

名称 在 必需 类型 说明
pipelineId
 path True

string

uuid

部署管道 ID

响应

名称 类型 说明
200 OK

PipelineOperations

确定

示例

Get pipeline operations example

示例请求

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations

示例响应

状态代码:
200 
{
  "value": [
    {
      "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,
      "note": {
        "content": "Sample note",
        "isTruncated": false
      },
      "preDeploymentDiffInformation": {
        "newArtifactsCount": 0,
        "differentArtifactsCount": 0,
        "noDifferenceArtifactsCount": 1
      },
      "performedBy": {
        "userPrincipalName": "john@contoso.com",
        "principalType": "User"
      }
    }
  ]
}

定义

名称 说明
DeploymentError

部署步骤的错误详细信息
DeploymentExecutionPlan

部署执行计划
DeploymentExecutionStep

部署执行步骤
DeploymentExecutionStepPreDeploymentDiffState

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

源项和目标项
DeploymentStepType

部署步骤的类型
PipelineOperation

Power BI 部署管道操作
PipelineOperationNote

描述部署的说明。
PipelineOperations

Power BI 部署管道操作集合的 OData 响应包装器
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

Enumeration

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

值 说明
Different

在部署之前，源阶段中的项与目标阶段中的项不同。
New

目标阶段中不存在的新已部署项。
NoDifference

在部署之前，源阶段中的项与目标阶段中的项相同。

DeploymentSourceAndTarget

Object

源项和目标项

名称 类型 说明
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

Enumeration

部署步骤的类型

值 说明
DashboardDeployment

部署单个仪表板的步骤
DataflowDeployment

部署单个数据流的步骤
DatamartDeployment

部署单个数据市场的步骤
DatasetDeployment

部署单个数据集的步骤
ReportDeployment

部署单个报表的步骤

PipelineOperation

Object

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

Object

描述部署的说明。

名称 类型 说明
content

string

描述部署的文本。
isTruncated

boolean

指示注释是否不完整。 True，仅返回部分注释。 False，说明已完成。

PipelineOperations

Object

Power BI 部署管道操作集合的 OData 响应包装器

名称 类型 说明
@odata.context

string

OData 上下文
value

PipelineOperation[]

部署管道操作的集合

PipelineOperationStatus

Enumeration

管道操作状态

值 说明
Executing

正在执行的操作
Failed

操作失败
NotStarted

操作未启动
Succeeded

操作成功

PipelineOperationType

Enumeration

操作类型

值 说明
Deploy

在阶段之间部署内容

PipelineOperationUser

Object

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

名称 类型 说明
principalObjectID

string

执行部署的服务主体的 ID。
principalType

PrincipalType

执行部署的用户的类型。
userPrincipalName

string

执行部署的用户的 UPN。

PreDeploymentDiffInformation

Object

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

名称 类型 说明
differentArtifactsCount

integer

部署前源阶段和目标阶段之间存在差异的已部署项数。
newArtifactsCount

integer

部署到目标阶段的新项数。
noDifferenceArtifactsCount

integer

部署前源阶段和目标阶段中部署的相同项数。

PrincipalType

Enumeration

主体类型

值 说明
App

服务主体类型
Group

组主体类型
None

无主体类型。 用于整个组织级别的访问。
User

用户主体类型