通过

Deployment Pipelines - Create Deployment Pipeline

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

创建新的部署管道。

权限

服务主体必须具有 Fabric 管理员授予的权限。 有关详细信息，请参阅： 服务主体可以创建工作区、连接和部署管道。

所需的委派范围

Pipeline.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

POST https://api.fabric.microsoft.com/v1/deploymentPipelines

请求正文

名称 必需 类型 说明
displayName True

string

maxLength: 256

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

DeploymentPipelineStageRequest[]

部署管道阶段的集合。
description

string

maxLength: 1024

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

响应

名称 类型 说明
201 Created

DeploymentPipelineExtendedInfo

已成功创建。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误

示例

Create a deployment pipeline example

示例请求

POST https://api.fabric.microsoft.com/v1/deploymentPipelines

{
  "displayName": "My Deployment Pipeline Name",
  "description": "My deployment pipeline description",
  "stages": [
    {
      "displayName": "Development",
      "description": "Development stage description",
      "isPublic": false
    },
    {
      "displayName": "Test",
      "description": "Test stage description",
      "isPublic": false
    },
    {
      "displayName": "Production",
      "description": "Production stage description",
      "isPublic": true
    }
  ]
}

示例响应

状态代码:
201 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline Name",
  "description": "My 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
    }
  ]
}

定义

名称 说明
CreateDeploymentPipelineRequest

创建新部署管道的请求。
DeploymentPipelineExtendedInfo

Fabric 部署管道。
DeploymentPipelineStage

Fabric 部署管道阶段。
DeploymentPipelineStageRequest

Fabric 部署管道阶段。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。

CreateDeploymentPipelineRequest

Object

创建新部署管道的请求。

名称 类型 说明
description

string

maxLength: 1024

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

string

maxLength: 256

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

DeploymentPipelineStageRequest[]

部署管道阶段的集合。

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

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

DeploymentPipelineStageRequest

Object

Fabric 部署管道阶段。

名称 类型 说明
description

string

maxLength: 1024

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

string

maxLength: 256

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

boolean

部署管道阶段是否为公共阶段。

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

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