Compartilhar via

Deployment Pipelines - Create Deployment Pipeline

Serviço:
Core
Versão da API:
v1

Cria um novo pipeline de implantação.

Permissões

As Entidades de Serviço devem ter permissão concedida pelo administrador do Fabric. Para obter mais informações, consulte: as entidades de serviço podem criar workspaces, conexões e pipelines de implantação.

Escopos delegados necessários

Pipeline.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interfase

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

Corpo da solicitação

Nome Obrigatório Tipo Description
displayName True

string

maxLength: 256

O nome de exibição do pipeline de implantação.
O nome de exibição não pode conter mais de 256 caracteres.
stages True

DeploymentPipelineStageRequest[]

A coleção de estágios de pipeline de implantação.
description

string

maxLength: 1024

A descrição do pipeline de implantação.
A descrição não pode conter mais de 1024 caracteres.

Respostas

Nome Tipo Description
201 Created

DeploymentPipelineExtendedInfo

Criado com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • UnknownError – Ocorreu um erro

Exemplos

Create a deployment pipeline example

Solicitação de exemplo

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
    }
  ]
}

Resposta de exemplo

Código de status:
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
    }
  ]
}

Definições

Nome Description
CreateDeploymentPipelineRequest

Uma solicitação para criar um pipeline de implantação.
DeploymentPipelineExtendedInfo

Um pipeline de implantação do Fabric.
DeploymentPipelineStage

Um estágio de pipeline de implantação do Fabric.
DeploymentPipelineStageRequest

Um estágio de pipeline de implantação do Fabric.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.

CreateDeploymentPipelineRequest

Objeto

Uma solicitação para criar um pipeline de implantação.

Nome Tipo Description
description

string

maxLength: 1024

A descrição do pipeline de implantação.
A descrição não pode conter mais de 1024 caracteres.
displayName

string

maxLength: 256

O nome de exibição do pipeline de implantação.
O nome de exibição não pode conter mais de 256 caracteres.
stages

DeploymentPipelineStageRequest[]

A coleção de estágios de pipeline de implantação.

DeploymentPipelineExtendedInfo

Objeto

Um pipeline de implantação do Fabric.

Nome Tipo Description
description

string

A descrição do pipeline de implantação.
displayName

string

O nome de exibição do pipeline de implantação.
id

string (uuid)

A ID do pipeline de implantação.
stages

DeploymentPipelineStage[]

A coleção de estágios de pipeline de implantação.

DeploymentPipelineStage

Objeto

Um estágio de pipeline de implantação do Fabric.

Nome Tipo Description
description

string

A descrição do estágio do pipeline de implantação.
displayName

string

O nome de exibição do estágio do pipeline de implantação.
id

string (uuid)

A ID do estágio do pipeline de implantação.
isPublic

boolean

Indica se o estágio do pipeline de implantação é público. True - o palco é público, False - o palco não é público.
order

integer

A ordem do estágio, começando a partir de zero.
workspaceId

string (uuid)

A ID do workspace atribuída. Aplicável somente quando houver um workspace atribuído.
workspaceName

string

O nome do workspace atribuído. Aplicável somente quando há um workspace atribuído e o usuário tem acesso ao workspace.

DeploymentPipelineStageRequest

Objeto

Um estágio de pipeline de implantação do Fabric.

Nome Tipo Description
description

string

maxLength: 1024

A descrição do estágio do pipeline de implantação.
A descrição não pode conter mais de 1024 caracteres.
displayName

string

maxLength: 256

O nome de exibição do estágio do pipeline de implantação.
O nome de exibição não pode conter mais de 256 caracteres.
isPublic

boolean

Se o estágio do pipeline de implantação é público.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.