Runs - Run Pipeline
Executa um pipeline.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=6.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. |
pipeline
|
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 '6.1-preview.1' para usar essa versão da API. |
pipeline
|
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 depois de analisar modelos. |
resources |
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, opcionalmente, poderá fornecer YAML diferente. Isso permite que você visualize o documento YAML final sem confirmar um arquivo alterado. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
operação bem-sucedida |
Segurança
accessToken
Token de acesso pessoal. Use qualquer valor para o nome de usuário e o token como a senha.
Type:
basic
Definições
Nome | Description |
---|---|
Build |
|
Container |
|
Package |
|
Pipeline |
Uma referência a um pipeline. |
Pipeline |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
Repository | |
Repository |
|
Repository |
|
Repository |
|
Run | |
Run |
Configurações que influenciam as execuções de pipeline. |
Run |
|
Run |
|
Run |
|
Run |
|
Variable |
BuildResourceParameters
Nome | Tipo | Description |
---|---|---|
version |
string |
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 |
PipelineResourceParameters
Nome | Tipo | Description |
---|---|---|
version |
string |
ReferenceLinks
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 |
RepositoryResource
Nome | Tipo | Description |
---|---|---|
refName |
string |
|
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 |
A classe para representar uma coleção de links de referência REST. |
|
createdDate |
string |
|
finalYaml |
string |
|
finishedDate |
string |
|
id |
integer |
|
name |
string |
|
pipeline |
Uma referência a um pipeline. |
|
resources | ||
result | ||
state | ||
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 depois de analisar modelos. |
resources |
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, opcionalmente, poderá fornecer YAML diferente. Isso permite que você visualize o documento YAML final sem confirmar um arquivo alterado. |
RunResources
Nome | Tipo | Description |
---|---|---|
repositories |
<string,
Repository |
RunResourcesParameters
Nome | Tipo | Description |
---|---|---|
builds |
<string,
Build |
|
containers |
<string,
Container |
|
packages |
<string,
Package |
|
pipelines |
<string,
Pipeline |
|
repositories |
<string,
Repository |
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 |
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de