Releases - Update Release Environment

Service:

Release

API Version:

5.0-preview.6

Actualización del estado de un entorno de versión

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=5.0-preview.6

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentId	path	True	integer int32	Id. del entorno de versión.
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
releaseId	path	True	integer int32	Id. de la versión.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0-preview.6" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
comment	string	Obtiene o establece el comentario.
scheduledDeploymentTime	string	Obtiene o establece la hora de implementación programada.
status	EnvironmentStatus	Obtiene o establece el estado del entorno.
variables	<string,  ConfigurationVariableValue>	Establece la lista de variables de entorno que se reemplazarán en el momento de la implementación.

Respuestas

Nombre	Tipo	Description
200 OK	ReleaseEnvironment	operación correcta

Seguridad

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

Nombre	Description
vso.release_execute	Concede la capacidad de leer y actualizar artefactos de versión, incluidas las versiones, las definiciones de versión y la envrionment de versiones, y la capacidad de poner en cola una nueva versión.

Definiciones

Nombre	Description
ApprovalExecutionOrder
ApprovalOptions
ApprovalStatus	Obtiene o establece el estado de la aprobación.
ApprovalType	Obtiene o establece el tipo de aprobación.
AuthorizationHeader
ConditionType	Obtiene o establece el tipo de condición.
ConfigurationVariableValue
DataSourceBindingBase	Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.
Demand
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Obtiene el estado de la operación de la implementación.
DeploymentReason	Obtiene el motivo de la implementación.
DeploymentStatus	Obtiene el estado de la implementación.
DeployPhase
DeployPhaseStatus
DeployPhaseTypes
EnvironmentOptions
EnvironmentStatus	Obtiene el estado del entorno.
GateStatus
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Obtiene o establece el estado de la intervención manual.
ProcessParameters
ProjectReference
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	Días de la semana que se van a publicar
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus
VariableGroup
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Nombre	Tipo	Description
afterGatesAlways	string
afterSuccessfulGates	string
beforeGates	string

ApprovalOptions

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

ApprovalStatus

Obtiene o establece el estado de la aprobación.

Nombre	Tipo	Description
approved	string
canceled	string
pending	string
reassigned	string
rejected	string
skipped	string
undefined	string

ApprovalType

Obtiene o establece el tipo de aprobación.

Nombre	Tipo	Description
all	string
postDeploy	string
preDeploy	string
undefined	string

AuthorizationHeader

Nombre	Tipo	Description
name	string
value	string

ConditionType

Obtiene o establece el tipo de condición.

Nombre	Tipo	Description
artifact	string	El tipo de condición es artifact.
environmentState	string	El tipo de condición es el estado del entorno.
event	string	El tipo de condición es event.
undefined	string	El tipo de condición no está definido.

ConfigurationVariableValue

Nombre	Tipo	Description
allowOverride	boolean	Obtiene o establece si una variable se puede invalidar en el momento de la implementación o no.
isSecret	boolean	Obtiene o establece como variable es secreta o no.
value	string	Obtiene o establece el valor de la variable de configuración.

DataSourceBindingBase

Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.

Nombre	Tipo	Description
callbackContextTemplate	string	Formato de paginación compatible con este origen de datos (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	¿Se necesitan llamadas posteriores?
dataSourceName	string	Obtiene o establece el nombre del origen de datos.
endpointId	string	Obtiene o establece el identificador del punto de conexión.
endpointUrl	string	Obtiene o establece la dirección URL del punto de conexión de servicio.
headers	AuthorizationHeader[]	Obtiene o establece los encabezados de autorización.
initialContextTemplate	string	Define el valor inicial de los parámetros de consulta.
parameters	object	Obtiene o establece los parámetros del origen de datos.
resultSelector	string	Obtiene o establece el selector de resultados.
resultTemplate	string	Obtiene o establece la plantilla de resultado.
target	string	Obtiene o establece el destino del origen de datos.

Demand

Nombre	Tipo	Description
name	string
value	string

DeploymentAttempt

Nombre	Tipo	Description
attempt	integer
deploymentId	integer
hasStarted	boolean	Especifica si la implementación se ha iniciado o no.
id	integer
issues	Issue[]	Todos los problemas relacionados con la implementación
job	ReleaseTask
lastModifiedBy	IdentityRef
lastModifiedOn	string
operationStatus	DeploymentOperationStatus
postDeploymentGates	ReleaseGates
preDeploymentGates	ReleaseGates
queuedOn	string
reason	DeploymentReason
releaseDeployPhases	ReleaseDeployPhase[]
requestedBy	IdentityRef
requestedFor	IdentityRef
runPlanId	string
status	DeploymentStatus
tasks	ReleaseTask[]

DeploymentJob

Nombre	Tipo	Description
job	ReleaseTask
tasks	ReleaseTask[]

DeploymentOperationStatus

Obtiene el estado de la operación de la implementación.

Nombre	Tipo	Description
all	string	El estado de la operación de implementación es todo.
approved	string	Se aprueba el estado de la operación de implementación.
canceled	string	Se cancela el estado de la operación de implementación.
cancelling	string	El estado de la operación de implementación se cancela.
deferred	string	El estado de la operación de implementación se aplaza.
evaluatingGates	string	El estado de la operación de implementación es EvaluarGates.
gateFailed	string	El estado de la operación de implementación es GateFailed.
manualInterventionPending	string	El estado de la operación de implementación es manualintervention pendiente.
pending	string	El estado de la operación de implementación está pendiente.
phaseCanceled	string	El estado de la operación de implementación se cancela por fases.
phaseFailed	string	Error en el estado de la operación de implementación.
phaseInProgress	string	El estado de la operación de implementación es la inprogress de fase.
phasePartiallySucceeded	string	El estado de la operación de implementación es la fase parcialmente correcta.
phaseSucceeded	string	El estado de la operación de implementación es la fase correcta.
queued	string	El estado de la operación de implementación se pone en cola.
queuedForAgent	string	El estado de la operación de implementación se pone en cola para el agente.
queuedForPipeline	string	El estado de la operación de implementación se pone en cola para la canalización.
rejected	string	Se rechaza el estado de la operación de implementación.
scheduled	string	El estado de la operación de implementación está programado.
undefined	string	El estado de la operación de implementación no está definido.

DeploymentReason

Obtiene el motivo de la implementación.

Nombre	Tipo	Description
automated	string	El motivo de implementación se automatiza.
manual	string	El motivo de implementación es manual.
none	string	El motivo de la implementación no es ninguno.
redeployTrigger	string	El motivo de implementación es RedeployTrigger.
scheduled	string	El motivo de implementación está programado.

DeploymentStatus

Obtiene el estado de la implementación.

Nombre	Tipo	Description
all	string	El estado de implementación es todo.
failed	string	Error en el estado de implementación.
inProgress	string	El estado de implementación es inprogress.
notDeployed	string	El estado de implementación no se implementa.
partiallySucceeded	string	El estado de implementación se aplica parcialmente.
succeeded	string	El estado de implementación se realiza correctamente.
undefined	string	El estado de implementación no está definido.

DeployPhase

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

DeployPhaseStatus

Nombre	Tipo	Description
canceled	string
cancelling	string
failed	string
inProgress	string
notStarted	string
partiallySucceeded	string
skipped	string
succeeded	string
undefined	string

DeployPhaseTypes

Nombre	Tipo	Description
agentBasedDeployment	string
deploymentGates	string	Tipo de fase que contiene tareas que actúan como Puertas para que la implementación avance.
machineGroupBasedDeployment	string
runOnServer	string
undefined	string

EnvironmentOptions

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

EnvironmentStatus

Obtiene el estado del entorno.

Nombre	Tipo	Description
canceled	string
inProgress	string
notStarted	string
partiallySucceeded	string
queued	string
rejected	string
scheduled	string
succeeded	string
undefined	string

GateStatus

Nombre	Tipo	Description
canceled	string
failed	string
inProgress	string
none	string
pending	string
succeeded	string

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

IgnoredGate

Nombre	Tipo	Description
lastModifiedOn	string	Obtiene la fecha en la que se omite por última vez la puerta.
name	string	Nombre de puerta omitida.

Issue

Nombre	Tipo	Description
data	object
issueType	string
message	string

ManualIntervention

Nombre	Tipo	Description
approver	IdentityRef	Obtiene o establece la identidad que debe aprobar.
comments	string	Obtiene o establece comentarios para su aprobación.
createdOn	string	Obtiene la fecha en la que se creó.
id	integer	Obtiene el identificador único para la intervención manual.
instructions	string	Obtiene o establece instrucciones para la aprobación.
modifiedOn	string	Obtiene la fecha en la que se modificó.
name	string	Obtiene o establece el nombre.
release	ReleaseShallowReference	Obtiene releaseReference para la intervención manual.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene releaseDefinitionReference para la intervención manual.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtiene releaseEnvironmentReference para la intervención manual.
status	ManualInterventionStatus	Obtiene o establece el estado de la intervención manual.
taskInstanceId	string	Obtiene el identificador de instancia de tarea.
url	string	Obtiene la dirección URL para acceder a la intervención manual.

ManualInterventionStatus

Obtiene o establece el estado de la intervención manual.

Nombre	Tipo	Description
approved	string	Se aprueba la intervención manual.
canceled	string	Se cancela la intervención manual.
pending	string	La intervención manual está pendiente.
rejected	string	Se rechaza la intervención manual.
unknown	string	La intervención manual no tiene el estado establecido.

ProcessParameters

Nombre	Tipo	Description
dataSourceBindings	DataSourceBindingBase[]	Representa el enlace del origen de datos para la solicitud del punto de conexión de servicio.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Nombre	Tipo	Description
id	string	Obtiene el identificador único de este campo.
name	string	Obtiene el nombre del proyecto.

ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

ReleaseApproval

Nombre	Tipo	Description
approvalType	ApprovalType	Obtiene o establece el tipo de aprobación.
approvedBy	IdentityRef	Obtiene la identidad que ha aprobado.
approver	IdentityRef	Obtiene o establece la identidad que debe aprobar.
attempt	integer	Obtiene o establece el intento que especifica el intento de implementación al que pertenece.
comments	string	Obtiene o establece comentarios para su aprobación.
createdOn	string	Obtiene la fecha en la que se creó.
history	ReleaseApprovalHistory[]	Obtiene el historial que especifica todas las aprobaciones asociadas a esta aprobación.
id	integer	Obtiene el identificador único de este campo.
isAutomated	boolean	Obtiene o establece como aprobación automatizada o no.
isNotificationOn	boolean
modifiedOn	string	Obtiene la fecha en la que se modificó.
rank	integer	Obtiene o establece la clasificación que especifica el orden de la aprobación. Por ejemplo, la misma clasificación denota la aprobación en paralelo.
release	ReleaseShallowReference	Obtiene releaseReference que especifica la referencia de la versión a la que está asociada esta aprobación.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociada esta aprobación.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtiene releaseEnvironmentReference, que especifica la referencia del entorno de versión al que está asociada esta aprobación.
revision	integer	Obtiene el número de revisión.
status	ApprovalStatus	Obtiene o establece el estado de la aprobación.
trialNumber	integer
url	string	Obtiene la dirección URL para acceder a la aprobación.

ReleaseApprovalHistory

Nombre	Tipo	Description
approver	IdentityRef
changedBy	IdentityRef
comments	string
createdOn	string
modifiedOn	string
revision	integer

ReleaseCondition

Nombre	Tipo	Description
conditionType	ConditionType	Obtiene o establece el tipo de condición.
name	string	Obtiene o establece el nombre de la condición. Por ejemplo, "ReleaseStarted".
result	boolean
value	string	Obtiene o establece el valor de la condición.

ReleaseDefinitionApprovals

Nombre	Tipo	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

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

ReleaseDefinitionGate

Nombre	Tipo	Description
tasks	WorkflowTask[]

ReleaseDefinitionGatesOptions

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

ReleaseDefinitionGatesStep

Nombre	Tipo	Description
gates	ReleaseDefinitionGate[]
gatesOptions	ReleaseDefinitionGatesOptions
id	integer

ReleaseDefinitionShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión.
id	integer	Obtiene el identificador único de la definición de versión.
name	string	Obtiene o establece el nombre de la definición de versión.
path	string	Obtiene o establece la ruta de acceso de la definición de versión.
projectReference	ProjectReference	Obtiene o establece la referencia del proyecto.
url	string	Obtiene la dirección URL de la API REST para acceder a la definición de versión.

ReleaseDeployPhase

Nombre	Tipo	Description
deploymentJobs	DeploymentJob[]
errorLog	string
id	integer
manualInterventions	ManualIntervention[]
name	string
phaseId	string
phaseType	DeployPhaseTypes
rank	integer
runPlanId	string
startedOn	string	Hora de inicio de la fase
status	DeployPhaseStatus

ReleaseEnvironment

Nombre	Tipo	Description
conditions	ReleaseCondition[]	Obtiene la lista de condiciones.
createdOn	string	Obtiene la fecha en la que se creó.
definitionEnvironmentId	integer	Obtiene el identificador de entorno de definición.
demands	Demand[]	Obtiene las demandas.
deployPhasesSnapshot	DeployPhase[]	Obtiene la lista de instantáneas de fases de implementación.
deploySteps	DeploymentAttempt[]	Obtiene los pasos de implementación.
environmentOptions	EnvironmentOptions	Obtiene las opciones de entorno.
id	integer	Obtiene el identificador único de este campo.
modifiedOn	string	Obtiene la fecha en la que se modificó.
name	string	Obtiene el nombre.
nextScheduledUtcTime	string	Obtiene la siguiente hora UTC programada.
owner	IdentityRef	Obtiene la identidad que es propietaria del entorno de versión.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Obtiene la lista de instantáneas posteriores a la implementación.
postDeployApprovals	ReleaseApproval[]	Obtiene la lista de aprobaciones posteriores a la implementación.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
preApprovalsSnapshot	ReleaseDefinitionApprovals	Obtiene la lista de instantáneas de aprobaciones de implementación previa.
preDeployApprovals	ReleaseApproval[]	Obtiene la lista de aprobaciones de implementación previa.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep
processParameters	ProcessParameters	Obtiene parámetros de proceso.
queueId	integer	Obtiene el identificador de cola.
rank	integer	Obtiene la clasificación.
release	ReleaseShallowReference	Obtiene la referencia de versión que especifica la referencia de la versión a la que está asociado este entorno de versión.
releaseCreatedBy	IdentityRef	Obtiene la identidad que creó la versión.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene releaseDefinitionReference que especifica la referencia de la definición de versión a la que está asociado este entorno de versión.
releaseDescription	string	Obtiene la descripción de la versión.
releaseId	integer	Obtiene el identificador de versión.
scheduledDeploymentTime	string	Obtiene la hora de implementación de la programación del entorno de versión.
schedules	ReleaseSchedule[]	Obtiene la lista de programaciones.
status	EnvironmentStatus	Obtiene el estado del entorno.
timeToDeploy	number	Obtiene el tiempo de implementación.
triggerReason	string	Obtiene el motivo del desencadenador.
variableGroups	VariableGroup[]	Obtiene la lista de grupos de variables.
variables	<string,  ConfigurationVariableValue>	Obtiene el diccionario de variables.
workflowTasks	WorkflowTask[]	Obtiene la lista de tareas de flujo de trabajo.

ReleaseEnvironmentShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para el entorno de versión.
id	integer	Obtiene el identificador único del entorno de versión.
name	string	Obtiene o establece el nombre del entorno de versión.
url	string	Obtiene la dirección URL de la API rest para acceder al entorno de versión.

ReleaseEnvironmentUpdateMetadata

Nombre	Tipo	Description
comment	string	Obtiene o establece el comentario.
scheduledDeploymentTime	string	Obtiene o establece el tiempo de implementación programado.
status	EnvironmentStatus	Obtiene o establece el estado del entorno.
variables	<string,  ConfigurationVariableValue>	Establece la lista de variables de entorno que se van a invalidar en el momento de la implementación.

ReleaseGates

Nombre	Tipo	Description
deploymentJobs	DeploymentJob[]
id	integer
ignoredGates	IgnoredGate[]
lastModifiedOn	string
runPlanId	string
stabilizationCompletedOn	string
startedOn	string
status	GateStatus
succeedingSince	string

ReleaseSchedule

Nombre	Tipo	Description
daysToRelease	ScheduleDays	Días de la semana que se van a publicar
jobId	string	Identificador de trabajo de definición de trabajo de Team Foundation
startHours	integer	Hora de zona horaria local para iniciarse
startMinutes	integer	Minuto de zona horaria local para empezar
timeZoneId	string	Identificador de zona horaria de la programación de lanzamiento, como "UTC"

ReleaseShallowReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la versión.
id	integer	Obtiene el identificador único de la versión.
name	string	Obtiene o establece el nombre de la versión.
url	string	Obtiene la dirección URL de la API rest para acceder a la versión.

ReleaseTask

Nombre	Tipo	Description
agentName	string
finishTime	string
id	integer
issues	Issue[]
lineCount	integer
logUrl	string
name	string
percentComplete	integer
rank	integer
resultCode	string
startTime	string
status	TaskStatus
task	WorkflowTaskReference
timelineRecordId	string

ScheduleDays

Días de la semana que se van a publicar

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

TaskInputDefinitionBase

Nombre	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

Nombre	Tipo	Description
expression	string	Expresión condicional
message	string	Mensaje que explica cómo el usuario puede corregir si se produce un error en la validación

TaskSourceDefinitionBase

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

TaskStatus

Nombre	Tipo	Description
canceled	string
failed	string
failure	string
inProgress	string
partiallySucceeded	string
pending	string
skipped	string
succeeded	string
success	string
unknown	string

VariableGroup

Nombre	Tipo	Description
createdBy	IdentityRef	Obtiene o establece la identidad que creó.
createdOn	string	Obtiene la fecha en la que se creó.
description	string	Obtiene o establece la descripción.
id	integer	Obtiene el identificador único de este campo.
isShared	boolean	Indica si un grupo de variables se comparte con otro proyecto o no.
modifiedBy	IdentityRef	Obtiene o establece la identidad que modificó.
modifiedOn	string	Obtiene la fecha en la que se modificó.
name	string	Obtiene o establece el nombre.
providerData	VariableGroupProviderData	Obtiene o establece los datos del proveedor.
type	string	Obtiene o establece el tipo.
variables	<string,  VariableValue>

VariableGroupProviderData

VariableValue

Nombre	Tipo	Description
isSecret	boolean
value	string

WorkflowTask

Nombre	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

WorkflowTaskReference

Nombre	Tipo	Description
id	string
name	string
version	string