Deployment Pipelines - Get Deployment Pipeline Operation

参考

服务:: Core

API 版本:: v1

返回对指定部署管道执行的指定部署作的详细信息，包括部署执行计划。

权限

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

所需的委派范围

Pipeline.Read.All 或 Pipeline.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}/operations/{operationId}

URI 参数

名称	在	必需	类型	说明
deploymentPipelineId	path	True	string (uuid)	部署管道 ID。
operationId	path	True	string (uuid)	作 ID。

响应

名称	类型	说明
200 OK	DeploymentPipelineOperationExtendedInfo	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误

名称

类型

说明

200 OK

DeploymentPipelineOperationExtendedInfo

请求成功完成。

Other Status Codes

ErrorResponse

常见错误代码：

UnknownError - 发生错误

示例

Get a deployment pipeline operation example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/deploymentPipelines/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",
  "sourceStageId": "2e6f0272-e809-410a-be63-50e1d97ba75a",
  "targetStageId": "d2056166-041c-4a56-8d37-ea90038bc0d6",
  "executionPlan": {
    "steps": [
      {
        "index": 0,
        "description": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceItemDisplayName": "Source dataflow",
          "itemType": "Dataflow"
        }
      },
      {
        "index": 1,
        "description": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceItemDisplayName": "Source datamart",
          "itemType": "Datamart"
        }
      },
      {
        "index": 2,
        "description": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "sourceItemId": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceItemDisplayName": "Source dataset",
          "targetItemId": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetItemDisplayName": "Target dataset",
          "itemType": "SemanticModel"
        }
      },
      {
        "index": 3,
        "description": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "sourceItemId": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceItemDisplayName": "Source report",
          "targetItemId": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetItemDisplayName": "Target report",
          "itemType": "Report"
        }
      },
      {
        "index": 4,
        "description": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "sourceItemId": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceItemDisplayName": "Source dashboard",
          "itemType": "Dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note"
  },
  "preDeploymentDiffInformation": {
    "newItemsCount": 3,
    "differentItemsCount": 1,
    "noDifferenceItemsCount": 1
  },
  "performedBy": {
    "id": "a35d842b-90d5-59a2-c56a-5f8fcff0bf9d",
    "type": "User"
  }
}

定义

名称	说明
DeploymentExecutionPlan	部署执行计划。
DeploymentExecutionStep	部署执行步骤。
DeploymentPipelineOperationExtendedInfo	Fabric 部署管道作。
DeploymentPipelineOperationNote	描述部署的注释。
DeploymentPipelineOperationStatus	部署管道作状态。可能会随着时间的推移添加其他状态。
DeploymentPipelineOperationType	作类型。可能会随着时间的推移添加其他类型。
DeploymentSourceAndTarget	源项和目标项。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GroupDetails	组特定详细信息。当主体类型 `Group`时适用。
GroupType	组的类型。可能会随着时间的推移添加其他组类型。
ItemPreDeploymentDiffState	指定在部署之前，项是新的、不同的或与目标阶段中的项相同。可能会随着时间的推移添加其他状态。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
PreDeploymentDiffInformation	部署前新、不同和相同的已部署项的数量。
Principal	表示标识或Microsoft Entra 组。
PrincipalType	主体的类型。可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails	服务主体特定详细信息。当主体类型 `ServicePrincipal`时适用。
ServicePrincipalProfileDetails	服务主体配置文件详细信息。当主体类型 `ServicePrincipalProfile`时适用。
UserDetails	用户主体特定详细信息。当主体类型 `User`时适用。

DeploymentExecutionPlan

Object

部署执行计划。

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

DeploymentExecutionStep

Object

部署执行步骤。

名称	类型	说明
description	string	部署步骤说明。
error	ErrorResponse	错误详细信息。仅当部署管道作失败时适用。
index	integer	步骤索引。
preDeploymentDiffState	ItemPreDeploymentDiffState	是部署前目标阶段中项的新项、不同项或相同项。
sourceAndTarget	DeploymentSourceAndTarget	步骤的源项和目标项。
status	DeploymentPipelineOperationStatus	部署管道作的状态。可能会随着时间的推移添加其他状态。

DeploymentPipelineOperationExtendedInfo

Object

Fabric 部署管道作。

名称	类型	说明
executionEndTime	string (date-time)	作结束的日期和时间。
executionPlan	DeploymentExecutionPlan	部署执行计划。
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。

DeploymentPipelineOperationStatus

枚举

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

值	说明
Failed	作失败
NotStarted	作未启动
Running	正在运行的作
Succeeded	作成功

DeploymentPipelineOperationType

枚举

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

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

DeploymentSourceAndTarget

Object

源项和目标项。

名称	类型	说明
itemType	ItemType	将在目标阶段覆盖的 Fabric 项的类型。仅当覆盖 Fabric 项时适用。
sourceItemDisplayName	string	从源阶段部署的 Fabric 项的显示名称。
sourceItemId	string (uuid)	从源阶段部署的 Fabric 项的 ID。
targetItemDisplayName	string	将在目标阶段覆盖的 Fabric 项的名称。仅当覆盖 Fabric 项时适用。
targetItemId	string (uuid)	将在目标阶段中覆盖的 Fabric 项的 ID。仅当覆盖 Fabric 项时适用。

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

枚举

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

值	说明
DistributionList	主体是通讯组列表。
SecurityGroup	主体是安全组。
Unknown	主体组类型未知。

ItemPreDeploymentDiffState

枚举

指定在部署之前，项是新的、不同的或与目标阶段中的项相同。可能会随着时间的推移添加其他状态。

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

ItemType

枚举

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

值	说明
ApacheAirflowJob	ApacheAirflowJob。
CopyJob	复制作业。
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Dataflow	数据流。
Datamart	PowerBI Datamart。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	数字孪生生成器流。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredAzureDatabricksCatalog	镜像的 Azure databricks 目录。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
VariableLibrary	VariableLibrary。
Warehouse	仓库。
WarehouseSnapshot	仓库快照。

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

枚举

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

值	说明
Group	主体是安全组。
ServicePrincipal	主体是Microsoft Entra 服务主体。
ServicePrincipalProfile	主体是服务主体配置文件。
User	主体是Microsoft Entra 用户主体。

ServicePrincipalDetails

Object

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

名称	类型	说明
aadAppId	string (uuid)	服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

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

名称	类型	说明
parentPrincipal	Principal	服务主体配置文件的父主体。

UserDetails

Object

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

名称	类型	说明
userPrincipalName	string	用户主体名称。

通过

Deployment Pipelines - Get Deployment Pipeline Operation

权限

所需的委派范围

Microsoft Entra 支持的标识

接口

URI 参数

响应

示例

Get a deployment pipeline operation example

示例请求

示例响应

定义

DeploymentExecutionPlan

DeploymentExecutionStep

DeploymentPipelineOperationExtendedInfo

DeploymentPipelineOperationNote

DeploymentPipelineOperationStatus

DeploymentPipelineOperationType

DeploymentSourceAndTarget

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemPreDeploymentDiffState

ItemType

PreDeploymentDiffInformation

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails