Compartilhar via


Runs - Run Pipeline

Executa um pipeline.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1-preview.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
path True

string

O nome da organização do Azure DevOps.

pipelineId
path True

integer

int32

A ID do pipeline.

project
path True

string

ID do projeto ou nome do projeto

api-version
query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

pipelineVersion
query

integer

int32

A versão do pipeline.

Corpo da solicitação

Nome Tipo Description
previewRun

boolean

Se for true, não crie uma nova execução. Em vez disso, retorne o documento YAML final após analisar modelos.

resources

RunResourcesParameters

Os recursos necessários para a execução.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Se você usar a opção de execução de visualização, poderá, opcionalmente, fornecer YAML diferente. Isso permite que você visualize o documento YAML final sem confirmar um arquivo alterado.

Respostas

Nome Tipo Description
200 OK

Run

operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nome Description
vso.build_execute Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de enfileirar um build, atualizar propriedades de build e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.

Definições

Nome Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

Uma referência a um Pipeline.

PipelineResource
PipelineResourceParameters
ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

Configurações que influenciam as execuções de pipeline.

RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Nome Tipo Description
version

string

Container

Nome Tipo Description
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Nome Tipo Description
container

Container

ContainerResourceParameters

Nome Tipo Description
version

string

PackageResourceParameters

Nome Tipo Description
version

string

PipelineReference

Uma referência a um Pipeline.

Nome Tipo Description
folder

string

Pasta pipeline

id

integer

ID do pipeline

name

string

Nome do pipeline

revision

integer

Número de revisão

url

string

PipelineResource

Nome Tipo Description
pipeline

PipelineReference

Uma referência a um Pipeline.

version

string

PipelineResourceParameters

Nome Tipo Description
version

string

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Repository

Nome Tipo Description
type

RepositoryType

RepositoryResource

Nome Tipo Description
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Nome Tipo Description
refName

string

token

string

Esse é o token de segurança a ser usado ao se conectar ao repositório.

tokenType

string

Opcional. Esse é o tipo do token fornecido. Se não for fornecido, um tipo de "Portador" será assumido. Observação: use "Básico" para um token PAT.

version

string

RepositoryType

Nome Tipo Description
azureReposGit

string

azureReposGitHyphenated

string

gitHub

string

gitHubEnterprise

string

unknown

string

Run

Nome Tipo Description
_links

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

createdDate

string

finalYaml

string

finishedDate

string

id

integer

name

string

pipeline

PipelineReference

Uma referência a um Pipeline.

resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Configurações que influenciam as execuções de pipeline.

Nome Tipo Description
previewRun

boolean

Se for true, não crie uma nova execução. Em vez disso, retorne o documento YAML final após analisar modelos.

resources

RunResourcesParameters

Os recursos necessários para a execução.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Se você usar a opção de execução de visualização, poderá, opcionalmente, fornecer YAML diferente. Isso permite que você visualize o documento YAML final sem confirmar um arquivo alterado.

RunResources

Nome Tipo Description
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Nome Tipo Description
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Nome Tipo Description
canceled

string

failed

string

succeeded

string

unknown

string

RunState

Nome Tipo Description
canceling

string

completed

string

inProgress

string

unknown

string

Variable

Nome Tipo Description
isSecret

boolean

value

string