Builds - Update Build

Service:

Build

API Version:

5.0

Atualizações um build.

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?api-version=5.0

With optional parameters:

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?retry={retry}&api-version=5.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
buildId	path	True	integer int32	A ID do build.
organization	path	True	string	O nome da organização do Azure DevOps.
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 '5.0' para usar essa versão da api.
retry	query		boolean

Corpo da solicitação

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
buildNumber	string	O número/nome do build.
buildNumberRevision	integer	A revisão do número de build.
controller	BuildController	O controlador de build. Isso só será definido se o tipo de definição for Xaml.
definition	DefinitionReference	A definição associada ao build.
deleted	boolean	Indica se o build foi excluído.
deletedBy	IdentityRef	A identidade do processo ou da pessoa que excluiu o build.
deletedDate	string	A data em que o build foi excluído.
deletedReason	string	A descrição de como o build foi excluído.
demands	Demand[]	Uma lista de demandas que representa os recursos do agente exigidos por essa compilação.
finishTime	string	A hora em que o build foi concluído.
id	integer	A ID do build.
keepForever	boolean	Indica se o build deve ser ignorado por políticas de retenção.
lastChangedBy	IdentityRef	A identidade que representa o processo ou a pessoa que alterou a compilação pela última vez.
lastChangedDate	string	A data em que o build foi alterado pela última vez.
logs	BuildLogReference	Informações sobre os logs de build.
orchestrationPlan	TaskOrchestrationPlanReference	O plano de orquestração para o build.
parameters	string	Os parâmetros para o build.
plans	TaskOrchestrationPlanReference[]	Planos de orquestração associados ao build (build, limpeza)
priority	QueuePriority	A prioridade do build.
project	TeamProjectReference	O projeto da equipe.
properties	PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
quality	string	A qualidade do build xaml (bom, ruim etc.)
queue	AgentPoolQueue	A fila. Isso só será definido se o tipo de definição for Build.
queueOptions	QueueOptions	Opções adicionais para enfileirar o build.
queuePosition	integer	A posição atual do build na fila.
queueTime	string	A hora em que o build foi enfileirado.
reason	BuildReason	O motivo pelo qual o build foi criado.
repository	BuildRepository	O repositório.
requestedBy	IdentityRef	A identidade que enfileirava o build.
requestedFor	IdentityRef	A identidade em cujo nome o build foi enfileirado.
result	BuildResult	O resultado do build.
retainedByRelease	boolean	Indica se o build é retido por uma versão.
sourceBranch	string	O branch de origem.
sourceVersion	string	A versão de origem.
startTime	string	A hora em que o build foi iniciado.
status	BuildStatus	O status do build.
tags	string[]
triggerInfo	object	Informações específicas do sourceprovider sobre o que disparou o build
triggeredByBuild	Build	O build que disparou essa compilação por meio de um gatilho de conclusão de build.
uri	string	O URI da compilação.
url	string	A URL REST do build.
validationResults	BuildRequestValidationResult[]	Representa o resultado da validação de uma solicitação de build.

Respostas

Nome	Tipo	Description
200 OK	Build	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
AgentPoolQueue	Representa uma fila para compilações em execução.
Build	Representação de dados de um build.
BuildController
BuildLogReference	Representa uma referência a um log de build.
BuildReason	O motivo pelo qual o build foi criado.
BuildRepository	Representa um repositório usado por uma definição de build.
BuildRequestValidationResult	Representa o resultado da validação de uma solicitação de build.
BuildResult	O resultado do build.
BuildStatus	O build status.
ControllerStatus	O status do controlador.
DefinitionQueueStatus	Um valor que indica se os builds podem ser enfileirados nessa definição.
DefinitionReference	Representa uma referência a uma definição.
DefinitionType	O tipo da definição.
Demand	Representa uma demanda usada por uma definição ou build.
IdentityRef
ProjectState	Estado do projeto.
ProjectVisibility	Visibilidade do projeto.
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
QueueOptions	Opções adicionais para enfileirar o build.
QueuePriority	A prioridade do build.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TaskAgentPoolReference	Representa uma referência a um pool de agentes.
TaskOrchestrationPlanReference	Representa uma referência a um plano de orquestração.
TeamProjectReference	Representa uma referência superficial a um TeamProject.
ValidationResult	O resultado.

AgentPoolQueue

Representa uma fila para compilações em execução.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
id	integer	A ID da fila.
name	string	O nome da fila.
pool	TaskAgentPoolReference	O pool usado por essa fila.
url	string	O link http completo para o recurso.

Build

Representação de dados de um build.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
buildNumber	string	O número/nome do build.
buildNumberRevision	integer	A revisão do número de build.
controller	BuildController	O controlador de build. Isso só será definido se o tipo de definição for Xaml.
definition	DefinitionReference	A definição associada ao build.
deleted	boolean	Indica se o build foi excluído.
deletedBy	IdentityRef	A identidade do processo ou da pessoa que excluiu o build.
deletedDate	string	A data em que o build foi excluído.
deletedReason	string	A descrição de como o build foi excluído.
demands	Demand[]	Uma lista de demandas que representa os recursos do agente exigidos por essa compilação.
finishTime	string	A hora em que a compilação foi concluída.
id	integer	A ID do build.
keepForever	boolean	Indica se o build deve ser ignorado pelas políticas de retenção.
lastChangedBy	IdentityRef	A identidade que representa o processo ou a pessoa que alterou o build pela última vez.
lastChangedDate	string	A data em que o build foi alterado pela última vez.
logs	BuildLogReference	Informações sobre os logs de build.
orchestrationPlan	TaskOrchestrationPlanReference	O plano de orquestração para o build.
parameters	string	Os parâmetros para o build.
plans	TaskOrchestrationPlanReference[]	Planos de orquestração associados ao build (build, limpeza)
priority	QueuePriority	A prioridade do build.
project	TeamProjectReference	O projeto de equipe.
properties	PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
quality	string	A qualidade do build xaml (bom, ruim etc.)
queue	AgentPoolQueue	A fila. Isso só será definido se o tipo de definição for Build.
queueOptions	QueueOptions	Opções adicionais para enfileirar o build.
queuePosition	integer	A posição atual do build na fila.
queueTime	string	A hora em que o build foi enfileirado.
reason	BuildReason	O motivo pelo qual o build foi criado.
repository	BuildRepository	O repositório.
requestedBy	IdentityRef	A identidade que enfileirava o build.
requestedFor	IdentityRef	A identidade em cujo nome a compilação foi enfileirada.
result	BuildResult	O resultado do build.
retainedByRelease	boolean	Indica se o build é mantido por uma versão.
sourceBranch	string	O branch de origem.
sourceVersion	string	A versão de origem.
startTime	string	A hora em que a compilação foi iniciada.
status	BuildStatus	O status do build.
tags	string[]
triggerInfo	object	Informações específicas do sourceprovider sobre o que disparou o build
triggeredByBuild	Build	O build que disparou essa compilação por meio de um gatilho de conclusão de build.
uri	string	O URI da compilação.
url	string	A URL REST do build.
validationResults	BuildRequestValidationResult[]	Representa o resultado da validação de uma solicitação de build.

BuildController

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
createdDate	string	A data em que o controlador foi criado.
description	string	A descrição do controlador.
enabled	boolean	Indica se o controlador está habilitado.
id	integer	ID do recurso
name	string	Nome do recurso vinculado (nome da definição, nome do controlador etc.)
status	ControllerStatus	O status do controlador.
updatedDate	string	A data em que o controlador foi atualizado pela última vez.
uri	string	O URI do controlador.
url	string	Link http completo para o recurso

BuildLogReference

Representa uma referência a um log de build.

Nome	Tipo	Description
id	integer	A ID do log.
type	string	O tipo do local do log.
url	string	Um link completo para o recurso de log.

BuildReason

O motivo pelo qual o build foi criado.

Nome	Tipo	Description
all	string	Todos os motivos.
batchedCI	string	O build foi iniciado para o gatilho TriggerType.BatchedContinuousIntegration.
buildCompletion	string	O build foi iniciado quando outro build foi concluído.
checkInShelveset	string	O build foi iniciado para o gatilho ContinuousIntegrationType.Gated.
individualCI	string	O build foi iniciado para o gatilho TriggerType.ContinuousIntegration.
manual	string	O build foi iniciado manualmente.
none	string	Sem motivo. Esse valor não deve ser usado.
pullRequest	string	O build foi iniciado por uma solicitação de pull. Adicionado no recurso versão 3.
schedule	string	O build foi iniciado para o gatilho TriggerType.Schedule.
triggered	string	O build foi disparado para fins de política de retenção.
userCreated	string	O build foi criado por um usuário.
validateShelveset	string	O build foi iniciado manualmente para validação privada.

BuildRepository

Representa um repositório usado por uma definição de build.

Nome	Tipo	Description
checkoutSubmodules	boolean	Indica se os submódulos de check-out devem ser verificados.
clean	string	Indica se a pasta de destino deve ser limpo ao obter código do repositório.
defaultBranch	string	O nome do branch padrão.
id	string	A ID do repositório.
name	string	O nome amigável do repositório.
properties	object
rootFolder	string	A pasta raiz.
type	string	O tipo do repositório.
url	string	A URL do repositório.

BuildRequestValidationResult

Representa o resultado da validação de uma solicitação de build.

Nome	Tipo	Description
message	string	A mensagem associada ao resultado.
result	ValidationResult	O resultado.

BuildResult

O resultado do build.

Nome	Tipo	Description
canceled	string	O build foi cancelado antes de ser iniciado.
failed	string	O build foi concluído sem êxito.
none	string	Nenhum resultado
partiallySucceeded	string	O build concluiu a compilação com êxito, mas teve outros erros.
succeeded	string	O build foi concluído com êxito.

BuildStatus

O build status.

Nome	Tipo	Description
all	string	Todos os status.
cancelling	string	O build está sendo cancelado
completed	string	A compilação foi concluída.
inProgress	string	O build está em andamento no momento.
none	string	Sem status.
notStarted	string	O build ainda não foi iniciado.
postponed	string	O build está inativo na fila.

ControllerStatus

O status do controlador.

Nome	Tipo	Description
available	string	Indica que o controlador de build está disponível no momento.
offline	string	Indica que o controlador de build ficou offline.
unavailable	string	Indica que o controlador de build não pode ser contatado.

DefinitionQueueStatus

Um valor que indica se os builds podem ser enfileirados nessa definição.

Nome	Tipo	Description
disabled	string	Quando desabilitada, a fila de definição não permitirá que os builds sejam enfileirados pelos usuários e o sistema não enfileirará builds de integração agendada, restrita ou contínua. Os builds que já estão na fila não serão iniciados pelo sistema.
enabled	string	Quando habilitada, a fila de definição permite que os builds sejam enfileirados pelos usuários, o sistema enfileirará builds de integração agendada, restrita e contínua e os builds enfileirados serão iniciados pelo sistema.
paused	string	Quando pausada, a fila de definição permite que os builds sejam enfileirados pelos usuários e o sistema enfileirará builds de integração agendada, restrita e contínua. Os builds na fila não serão iniciados pelo sistema.

DefinitionReference

Representa uma referência a uma definição.

Nome	Tipo	Description
createdDate	string	A data em que a definição foi criada.
id	integer	A ID da definição referenciada.
name	string	O nome da definição referenciada.
path	string	O caminho da pasta da definição.
project	TeamProjectReference	Uma referência ao projeto.
queueStatus	DefinitionQueueStatus	Um valor que indica se os builds podem ser enfileirados nessa definição.
revision	integer	O número de revisão de definição.
type	DefinitionType	O tipo da definição.
uri	string	O URI da definição.
url	string	A URL REST da definição.

DefinitionType

O tipo da definição.

Nome	Tipo	Description
build	string
xaml	string

Demand

Representa uma demanda usada por uma definição ou build.

Nome	Tipo	Description
name	string	O nome da funcionalidade referenciada pela demanda.
value	string	O valor exigido.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações.
directoryAlias	string
displayName	string	Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ProjectState

Estado do projeto.

Nome	Tipo	Description
all	string	Todos os projetos, independentemente do estado.
createPending	string	O projeto foi enfileirado para criação, mas o processo ainda não foi iniciado.
deleted	string	O projeto foi excluído.
deleting	string	O Project está em processo de exclusão.
new	string	O projeto está em processo de criação.
unchanged	string	O projeto não foi alterado.
wellFormed	string	O project é completamente criado e pronto para uso.

ProjectVisibility

Visibilidade do projeto.

Nome	Tipo	Description
private	string	O projeto só é visível para usuários com acesso explícito.
public	string	O projeto é visível para todos.

PropertiesCollection

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Nome	Tipo	Description
count	integer	A contagem de propriedades na coleção.
item	object
keys	string[]	O conjunto de chaves na coleção.
values	string[]	O conjunto de valores na coleção.

QueueOptions

Opções adicionais para enfileirar o build.

Nome	Tipo	Description
doNotRun	string	Criar uma ID de plano para o build, não executá-la
none	string	Sem opções de fila

QueuePriority

A prioridade do build.

Nome	Tipo	Description
aboveNormal	string	Prioridade acima do normal.
belowNormal	string	Prioridade abaixo do normal.
high	string	Prioridade alta.
low	string	Baixa prioridade.
normal	string	Prioridade normal.

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.

TaskAgentPoolReference

Representa uma referência a um pool de agentes.

Nome	Tipo	Description
id	integer	A ID do pool.
isHosted	boolean	Um valor que indica se esse pool é gerenciado ou não pelo serviço.
name	string	O nome do pool.

TaskOrchestrationPlanReference

Representa uma referência a um plano de orquestração.

Nome	Tipo	Description
orchestrationType	integer	O tipo do plano.
planId	string	A ID do plano.

TeamProjectReference

Representa uma referência superficial a um TeamProject.

Nome	Tipo	Description
abbreviation	string	Abreviação do projeto.
defaultTeamImageUrl	string	Url para a imagem de identidade de equipe padrão.
description	string	A descrição do projeto (se houver).
id	string	Identificador do projeto.
name	string	Nome do projeto.
revision	integer	Revisão do projeto.
state	ProjectState	Estado do projeto.
url	string	URL para a versão completa do objeto.
visibility	ProjectVisibility	Visibilidade do projeto.

ValidationResult

O resultado.

Nome	Tipo	Description
error	string
oK	string
warning	string