通过

Deployment Pipelines - Update Deployment Pipeline

  • 参考
服务:
Core
API 版本:
v1

更新指定部署管道的属性。

权限

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

所需的委派范围

Pipeline.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

PATCH https://api.fabric.microsoft.com/v1/deploymentPipelines/{deploymentPipelineId}

URI 参数

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

string (uuid)

部署管道 ID。

请求正文

名称 类型 说明
description

string

maxLength: 1024

部署管道的说明。
说明不能包含超过 1024 个字符。
displayName

string

maxLength: 256

部署管道的显示名称。
显示名称不能包含超过 256 个字符。

响应

名称 类型 说明
200 OK

DeploymentPipelineExtendedInfo

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误

示例

Update a deployment pipeline example

示例请求

PATCH https://api.fabric.microsoft.com/v1/deploymentPipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824

{
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description"
}

示例响应

状态代码:
200 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "Updated Deployment Pipeline Name",
  "description": "Updated deployment pipeline description",
  "stages": [
    {
      "id": "2e6f0272-e809-410a-be63-50e1d97ba75a",
      "order": 0,
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "id": "d2056166-041c-4a56-8d37-ea90038bc0d6",
      "order": 1,
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "id": "4c3eb03b-fbbb-4605-9b1a-6fba1003679e",
      "order": 2,
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

定义

名称 说明
DeploymentPipelineExtendedInfo

Fabric 部署管道。
DeploymentPipelineStage

Fabric 部署管道阶段。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
UpdateDeploymentPipelineRequest

更新现有部署管道的请求。 需要更新的显示名称和/或说明。

DeploymentPipelineExtendedInfo

Object

Fabric 部署管道。

名称 类型 说明
description

string

部署管道说明。
displayName

string

部署管道显示名称。
id

string (uuid)

部署管道 ID。
stages

DeploymentPipelineStage[]

部署管道阶段的集合。

DeploymentPipelineStage

Object

Fabric 部署管道阶段。

名称 类型 说明
description

string

部署管道阶段说明。
displayName

string

部署管道阶段显示名称。
id

string (uuid)

部署管道阶段 ID。
isPublic

boolean

指示部署管道阶段是否为公共阶段。 True - 阶段为公共阶段，False - 阶段不公开。
order

integer

阶段顺序，从零开始。
workspaceId

string (uuid)

分配的工作区 ID。 仅当有分配的工作区时适用。
workspaceName

string

分配的工作区名称。 仅当有分配的工作区并且用户有权访问工作区时，才适用。

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

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

UpdateDeploymentPipelineRequest

Object

更新现有部署管道的请求。 需要更新的显示名称和/或说明。

名称 类型 说明
description

string

maxLength: 1024

部署管道的说明。
说明不能包含超过 1024 个字符。
displayName

string

maxLength: 256

部署管道的显示名称。
显示名称不能包含超过 256 个字符。