Definitions - Update

Service:

Release

API Version:

5.0

Atualizar uma definição de versão.

PUT https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=5.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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 esta versão da API.

Corpo da solicitação

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
artifacts	Artifact[]	Obtém ou define a lista de artefatos.
comment	string	Obtém ou define o comentário.
createdBy	IdentityRef	Obtém ou define a identidade que criou.
createdOn	string	Obtém a data em que ela foi criada.
description	string	Obtém ou define a descrição.
environments	ReleaseDefinitionEnvironment[]	Obtém ou define a lista de ambientes.
id	integer	Obtém o identificador exclusivo da definição de versão.
isDeleted	boolean	Se a definição da versão é excluída.
lastRelease	ReleaseReference	Obtém a referência da última versão.
modifiedBy	IdentityRef	Obtém ou define a identidade que modificou.
modifiedOn	string	Obtém a data em que ela foi modificada.
name	string	Obtém ou define o nome da definição de versão.
path	string	Obtém ou define o caminho da definição de versão.
projectReference	ProjectReference	Obtém ou define a referência do projeto.
properties	PropertiesCollection	Obtém ou define propriedades.
releaseNameFormat	string	Obtém ou define o formato do nome da versão.
revision	integer	Obtém o número de revisão.
source	ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
tags	string[]	Obtém ou define a lista de marcas.
triggers	ReleaseTriggerBase[]	Obtém ou define a lista de gatilhos.
url	string	Obtém a URL da API REST para acessar a definição de versão.
variableGroups	integer[]	Obtém ou define a lista de grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém ou define o dicionário de variáveis.

Respostas

Nome	Tipo	Description
200 OK	ReleaseDefinition	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.release_execute	Concede a capacidade de ler e atualizar artefatos de versão, incluindo versões, definições de versão e configuração de versão e a capacidade de enfileirar uma nova versão.

Definições

Nome	Description
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Obtém ou define o tipo de condição.
ConfigurationVariableValue
DataSourceBindingBase	Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço.
Demand
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy	Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
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.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
ReleaseReason	Obtém o motivo da liberação.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays	Dias da semana para lançamento
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Nome	Tipo	Description
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

Nome	Tipo	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean
enforceIdentityRevalidation	boolean
executionOrder	ApprovalExecutionOrder
releaseCreatorCanBeApprover	boolean
requiredApproverCount	integer
timeoutInMinutes	integer

Artifact

Nome	Tipo	Description
alias	string	Obtém ou define o alias.
definitionReference	<string,  ArtifactSourceReference>	Obtém ou define a referência de definição. por exemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary	boolean	Obtém ou define como artefato é primário ou não.
isRetained	boolean
type	string	Obtém ou define o tipo. Ele pode ter valor como 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (externo)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactSourceReference

Nome	Tipo	Description
id	string
name	string

AuthorizationHeader

Nome	Tipo	Description
name	string
value	string

Condition

Nome	Tipo	Description
conditionType	ConditionType	Obtém ou define o tipo de condição.
name	string	Obtém ou define o nome da condição. por exemplo, 'ReleaseStarted'.
value	string	Obtém ou define o valor da condição.

ConditionType

Obtém ou define o tipo de condição.

Nome	Tipo	Description
artifact	string	O tipo de condição é artifact.
environmentState	string	O tipo de condição é o estado do ambiente.
event	string	O tipo de condição é event.
undefined	string	O tipo de condição é indefinido.

ConfigurationVariableValue

Nome	Tipo	Description
allowOverride	boolean	Obtém ou define se uma variável pode ser substituída no momento da implantação ou não.
isSecret	boolean	Obtém ou define como variável é segredo ou não.
value	string	Obtém ou define o valor da variável de configuração.

DataSourceBindingBase

Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço.

Nome	Tipo	Description
callbackContextTemplate	string	Formato de paginação compatível com essa fonte de dados (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Chamadas subsequentes necessárias?
dataSourceName	string	Obtém ou define o nome da fonte de dados.
endpointId	string	Obtém ou define a ID do ponto de extremidade.
endpointUrl	string	Obtém ou define a URL do ponto de extremidade de serviço.
headers	AuthorizationHeader[]	Obtém ou define os cabeçalhos de autorização.
initialContextTemplate	string	Define o valor inicial dos parâmetros de consulta
parameters	object	Obtém ou define os parâmetros para a fonte de dados.
resultSelector	string	Obtém ou define o seletor de resultados.
resultTemplate	string	Obtém ou define o modelo de resultado.
target	string	Obtém ou define o destino da fonte de dados.

Demand

Nome	Tipo	Description
name	string
value	string

DeployPhase

Nome	Tipo	Description
name	string
phaseType	DeployPhaseTypes
rank	integer
refName	string
workflowTasks	WorkflowTask[]

DeployPhaseTypes

Nome	Tipo	Description
agentBasedDeployment	string
deploymentGates	string	Tipo de fase que contém tarefas que atuam como Portões para que a implantação avance.
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentExecutionPolicy

Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.

Nome	Tipo	Description
concurrencyCount	integer	Essa política decide quantos ambientes seriam com o Executor de Ambiente.
queueDepthCount	integer	Profundidade da fila na tabela EnvironmentQueue, essa tabela mantém as entradas de ambiente até que o Environment Runner esteja livre [de acordo com sua política] para usar outro ambiente para execução.

EnvironmentOptions

Nome	Tipo	Description
autoLinkWorkItems	boolean
badgeEnabled	boolean
emailNotificationType	string
emailRecipients	string
enableAccessToken	boolean
publishDeploymentStatus	boolean
pullRequestDeploymentEnabled	boolean
skipArtifactsDownload	boolean
timeoutInMinutes	integer

EnvironmentRetentionPolicy

Nome	Tipo	Description
daysToKeep	integer
releasesToKeep	integer
retainBuild	boolean

EnvironmentTrigger

Nome	Tipo	Description
definitionEnvironmentId	integer
releaseDefinitionId	integer
triggerContent	string
triggerType	EnvironmentTriggerType

EnvironmentTriggerType

Nome	Tipo	Description
deploymentGroupRedeploy	string
rollbackRedeploy	string
undefined	string

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.

ProcessParameters

Nome	Tipo	Description
dataSourceBindings	DataSourceBindingBase[]	Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Nome	Tipo	Description
id	string	Obtém o identificador exclusivo desse campo.
name	string	Obtém o nome 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.

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.

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.

ReleaseDefinition

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
artifacts	Artifact[]	Obtém ou define a lista de artefatos.
comment	string	Obtém ou define o comentário.
createdBy	IdentityRef	Obtém ou define a identidade que criou.
createdOn	string	Obtém a data em que ela foi criada.
description	string	Obtém ou define a descrição.
environments	ReleaseDefinitionEnvironment[]	Obtém ou define a lista de ambientes.
id	integer	Obtém o identificador exclusivo da definição de versão.
isDeleted	boolean	Se a definição da versão é excluída.
lastRelease	ReleaseReference	Obtém a referência da última versão.
modifiedBy	IdentityRef	Obtém ou define a identidade que modificou.
modifiedOn	string	Obtém a data em que ela foi modificada.
name	string	Obtém ou define o nome da definição de versão.
path	string	Obtém ou define o caminho da definição de versão.
projectReference	ProjectReference	Obtém ou define a referência do projeto.
properties	PropertiesCollection	Obtém ou define propriedades.
releaseNameFormat	string	Obtém ou define o formato do nome da versão.
revision	integer	Obtém o número de revisão.
source	ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
tags	string[]	Obtém ou define a lista de marcas.
triggers	ReleaseTriggerBase[]	Obtém ou define a lista de gatilhos.
url	string	Obtém a URL da API REST para acessar a definição de versão.
variableGroups	integer[]	Obtém ou define a lista de grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém ou define o dicionário de variáveis.

ReleaseDefinitionApprovals

Nome	Tipo	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

Nome	Tipo	Description
approver	IdentityRef
id	integer
isAutomated	boolean
isNotificationOn	boolean
rank	integer

ReleaseDefinitionDeployStep

Nome	Tipo	Description
id	integer
tasks	WorkflowTask[]	A lista de etapas para essa definição.

ReleaseDefinitionEnvironment

Nome	Tipo	Description
badgeUrl	string
conditions	Condition[]
currentRelease	ReleaseShallowReference
demands	Demand[]
deployPhases	DeployPhase[]
deployStep	ReleaseDefinitionDeployStep
environmentOptions	EnvironmentOptions
environmentTriggers	EnvironmentTrigger[]
executionPolicy	EnvironmentExecutionPolicy	Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.
id	integer
name	string
owner	IdentityRef
postDeployApprovals	ReleaseDefinitionApprovals
postDeploymentGates	ReleaseDefinitionGatesStep
preDeployApprovals	ReleaseDefinitionApprovals
preDeploymentGates	ReleaseDefinitionGatesStep
processParameters	ProcessParameters
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.
queueId	integer
rank	integer
retentionPolicy	EnvironmentRetentionPolicy
schedules	ReleaseSchedule[]
variableGroups	integer[]
variables	<string,  ConfigurationVariableValue>

ReleaseDefinitionGate

Nome	Tipo	Description
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

Nome	Tipo	Description
isEnabled	boolean
minimumSuccessDuration	integer
samplingInterval	integer
stabilizationTime	integer
timeout	integer

ReleaseDefinitionGatesStep

Nome	Tipo	Description
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
id	integer	Obtém o identificador exclusivo da definição de versão.
name	string	Obtém ou define o nome da definição de versão.
path	string	Obtém ou define o caminho da definição de versão.
projectReference	ProjectReference	Obtém ou define a referência do projeto.
url	string	Obtém a URL da API REST para acessar a definição de versão.

ReleaseDefinitionSource

Obtém ou define a origem da definição de versão.

Nome	Tipo	Description
ibiza	string
portalExtensionApi	string
restApi	string
undefined	string
userInterface	string

ReleaseReason

Obtém o motivo da liberação.

Nome	Tipo	Description
continuousIntegration	string
manual	string
none	string
pullRequest	string
schedule	string

ReleaseReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém links para acessar a versão.
artifacts	Artifact[]	Obtém a lista de artefatos.
createdBy	IdentityRef	Obtém a identidade que criou.
createdOn	string	Obtém a data em que ela foi criada.
description	string	Obtém a descrição.
id	integer	Obtém o identificador exclusivo desse campo.
modifiedBy	IdentityRef	Obtém a identidade que modificou.
name	string	Obtém o nome da versão.
reason	ReleaseReason	Obtém o motivo da liberação.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém a referência superficial da definição de versão.

ReleaseSchedule

Nome	Tipo	Description
daysToRelease	ScheduleDays	Dias da semana para lançamento
jobId	string	ID do trabalho de definição de trabalho do Team Foundation
startHours	integer	Hora de fuso horário local para iniciar
startMinutes	integer	Minuto de fuso horário local para iniciar
timeZoneId	string	ID de fuso horário do agendamento de lançamento, como 'UTC'

ReleaseShallowReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a versão.
id	integer	Obtém o identificador exclusivo da versão.
name	string	Obtém ou define o nome da versão.
url	string	Obtém a URL da API REST para acessar a versão.

ReleaseTriggerBase

Nome	Tipo	Description
triggerType	ReleaseTriggerType

ReleaseTriggerType

Nome	Tipo	Description
artifactSource	string
containerImage	string
package	string
pullRequest	string
schedule	string
sourceRepo	string
undefined	string

ScheduleDays

Dias da semana para lançamento

Nome	Tipo	Description
all	string
friday	string
monday	string
none	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

TaskInputDefinitionBase

Nome	Tipo	Description
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Nome	Tipo	Description
expression	string	Expressões condicionais
message	string	Mensagem explicando como o usuário pode corrigir se a validação falhar

TaskSourceDefinitionBase

Nome	Tipo	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

WorkflowTask

Nome	Tipo	Description
alwaysRun	boolean
condition	string
continueOnError	boolean
definitionType	string
enabled	boolean
environment	object
inputs	object
name	string
overrideInputs	object
refName	string
taskId	string
timeoutInMinutes	integer
version	string