通过

Deployment Pipelines - List Deployment Pipeline Operations

服务:
Core
API 版本:
v1

返回对指定部署管道执行的 up-to-20 最新部署作的列表。

权限

调用方必须具有 管理员 部署管道角色。

所需的委派范围

Pipeline.Read.All 或 Pipeline.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations
具有可选参数: 
GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations?continuationToken={continuationToken}

URI 参数

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

string (uuid)

部署管道 ID。
continuationToken
 query

string

用于检索下一页结果的令牌。

响应

名称 类型 说明
200 OK

DeploymentPipelineOperations

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误

示例

List deployment pipeline operations example
List deployment pipeline operations with continuation example

List deployment pipeline operations example

示例请求

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/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",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Sample note"
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 0,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 1
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    },
    {
      "id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
      "type": "Deploy",
      "status": "Failed",
      "lastUpdatedTime": "2020-12-14T09:26:43.153",
      "executionStartTime": "2020-12-14T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
        "isTruncated": true
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 1,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 0
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    }
  ]
}

List deployment pipeline operations with continuation example

示例请求

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/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",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Sample note"
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 0,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 1
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    },
    {
      "id": "7e113010-3264-41e4-93c1-1dfb34a93d06",
      "type": "Deploy",
      "status": "Failed",
      "lastUpdatedTime": "2020-12-14T09:26:43.153",
      "executionStartTime": "2020-12-14T09:25:43.153Z",
      "executionEndTime": "2020-12-13T09:26:43.153Z",
      "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "note": {
        "content": "Lorem ipsum odor amet, consectetuer adipiscing elit. Himenaeos litora volutpat sem eget ipsum sollicitudin ad porta ligula tristique sapien suscipit magnis pulvinar placerat in vulputate aliquam mauris aptent velit phasellus netus fringilla ad taciti in himenaeos eu vitae feugiat et auctor class maximus urna integer erat amet efficitur ex tellus conubia lorem nam viverra cras magnis potenti pharetra natoque suscipit scelerisque eros adipiscing mollis sagittis habitasse ligula nullam rhoncus at scelerisque justo dolor pretium libero urna massa tristique diam viverra aenean mauris malesuada mus sed ultrices consectetur tristique pretium imperdiet vulputate ligula senectus pretium aenean inceptos id cras magna ut nisl etiam eget magna nibh feugiat duis imperdiet ut ornare arcu primis curae taciti purus quisque turpis lacus auctor ligula tristique placerat consectetur mus vitae penatibus varius proin ligula viverra diam neque at tortor porttitor urna ullamcorper ut nec lobortis porta urna egestas eu cursus ante ",
        "isTruncated": true
      },
      "preDeploymentDiffInformation": {
        "newItemsCount": 1,
        "differentItemsCount": 0,
        "noDifferenceItemsCount": 0
      },
      "performedBy": {
        "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
        "type": "User"
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations?continuationToken=LDEsMTAwMDAwLDA%3D"
}

定义

名称 说明
DeploymentPipelineOperation

Fabric 部署管道作。
DeploymentPipelineOperationNote

描述部署的注释。
DeploymentPipelineOperations

Fabric 部署管道作的集合。
DeploymentPipelineOperationStatus

部署管道作状态。 可能会随着时间的推移添加其他状态。
DeploymentPipelineOperationType

作类型。 可能会随着时间的推移添加其他类型。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GroupDetails

组特定详细信息。 当主体类型 Group时适用。
GroupType

组的类型。 可能会随着时间的推移添加其他组类型。
PreDeploymentDiffInformation

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

表示标识或Microsoft Entra 组。
PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

DeploymentPipelineOperation

Object

Fabric 部署管道作。

名称 类型 说明
executionEndTime

string (date-time)

作结束的日期和时间。
executionStartTime

string (date-time)

作启动的日期和时间。
id

string (uuid)

作 ID。
lastUpdatedTime

string (date-time)

上次更新作的日期和时间。
note

DeploymentPipelineOperationNote

表示作说明的注释。
performedBy

Principal

执行部署管道作的主体。
preDeploymentDiffInformation

PreDeploymentDiffInformation

在部署之前，源阶段中已部署的项数（与目标阶段中的项相同或不同）。
sourceStageId

string (uuid)

源部署管道阶段的 ID。
status

DeploymentPipelineOperationStatus

部署管道作状态。 可能会随着时间的推移添加其他状态。
targetStageId

string (uuid)

目标部署管道阶段的 ID。
type

DeploymentPipelineOperationType

作类型。 可能会随着时间的推移添加其他类型。

DeploymentPipelineOperationNote

Object

描述部署的注释。

名称 类型 说明
content

string

描述部署的文本。
isTruncated

boolean

指示是否截断笔记内容。 True - 注释内容被截断，False - 注释内容不会被截断。 默认值为 false。

DeploymentPipelineOperations

Object

Fabric 部署管道作的集合。

名称 类型 说明
continuationToken

string

下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri

string

下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value

DeploymentPipelineOperation[]

部署管道作的集合。

DeploymentPipelineOperationStatus

枚举

部署管道作状态。 可能会随着时间的推移添加其他状态。

值 说明
NotStarted

作未启动
Running

正在运行的作
Succeeded

作成功
Failed

作失败

DeploymentPipelineOperationType

枚举

作类型。 可能会随着时间的推移添加其他类型。

值 说明
Deploy

在阶段之间部署内容。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

GroupDetails

Object

组特定详细信息。 当主体类型 Group时适用。

名称 类型 说明
groupType

GroupType

组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

枚举

组的类型。 可能会随着时间的推移添加其他组类型。

值 说明
Unknown

主体组类型未知。
SecurityGroup

主体是安全组。
DistributionList

主体是通讯组列表。

PreDeploymentDiffInformation

Object

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

名称 类型 说明
differentItemsCount

integer

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

integer

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

integer

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

Principal

Object

表示标识或Microsoft Entra 组。

名称 类型 说明
displayName

string

主体的显示名称。
groupDetails

GroupDetails

组特定详细信息。 当主体类型 Group时适用。
id

string (uuid)

主体的 ID。
servicePrincipalDetails

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

枚举

主体的类型。 可能会随着时间的推移添加其他主体类型。

值 说明
User

主体是Microsoft Entra 用户主体。
ServicePrincipal

主体是Microsoft Entra 服务主体。
Group

主体是安全组。
ServicePrincipalProfile

主体是服务主体配置文件。

ServicePrincipalDetails

Object

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称 类型 说明
aadAppId

string (uuid)

服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称 类型 说明
parentPrincipal

Principal

服务主体配置文件的父主体。

UserDetails

Object

用户主体特定详细信息。 当主体类型 User时适用。

名称 类型 说明
userPrincipalName

string

用户主体名称。