Definitions - Get

Service:

Release

API Version:

5.0

Obtenga una definición de versión.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
definitionId	path	True	integer int32	Identificador de la definición 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
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.
propertyFilters	query		string array (string)	Lista delimitada por comas de propiedades extendidas que se van a recuperar. Si se establece, la definición de versión devuelta contendrá valores para los identificadores de propiedad especificados (si existen). Si no se establece, no se incluirán las propiedades.

Respuestas

Nombre	Tipo	Description
200 OK	ReleaseDefinition	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	Concede la capacidad de leer artefactos de versión, incluidas las versiones, las definiciones de versión y el entorno de versión.

Definiciones

Nombre	Description
ApprovalExecutionOrder
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
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
DeployPhase
DeployPhaseTypes
EnvironmentExecutionPolicy	Define la directiva en cola del entorno en Release Management cola lateral. Enviaremos al ejecutor del entorno [creación de implementación previa y otros pasos] solo cuando se cumplan las directivas mencionadas.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object) excepto DBNull . Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Obtiene o establece el origen de la definición de versión.
ReleaseReason	Obtiene el motivo de la versión.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType
ScheduleDays	Días de la semana que se van a publicar
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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

Artifact

Nombre	Tipo	Description
alias	string	Obtiene o establece alias.
definitionReference	<string,  ArtifactSourceReference>	Obtiene o establece la referencia de definición. Por ejemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
isPrimary	boolean	Obtiene o establece como artefacto principal o no.
isRetained	boolean
type	string	Obtiene o establece el tipo. Puede tener el valor "Build", "Jenkins", "GitHub", "Nuget", "Team Build (external)", "ExternalTFSBuild", "Git", "TFVC", "ExternalTfsXamlBuild".

ArtifactSourceReference

Nombre	Tipo	Description
id	string
name	string

AuthorizationHeader

Nombre	Tipo	Description
name	string
value	string

Condition

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".
value	string	Obtiene o establece el valor de la condición.

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 se puede invalidar una variable 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 admitido por este origen de datos(ContinuationToken/SkipTop).
callbackRequiredTemplate	string	¿Se necesitan llamadas subsiguientes?
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

DeployPhase

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

DeployPhaseTypes

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

EnvironmentExecutionPolicy

Define la directiva en cola del entorno en Release Management cola lateral. Enviaremos al ejecutor del entorno [creación de implementación previa y otros pasos] solo cuando se cumplan las directivas mencionadas.

Nombre	Tipo	Description
concurrencyCount	integer	Esta directiva decide cuántos entornos serían con El ejecutor del entorno.
queueDepthCount	integer	Profundidad de la cola en la tabla EnvironmentQueue, esta tabla mantiene las entradas de entorno hasta que Environment Runner esté libre [según la directiva] para tomar otro entorno para su ejecución.

EnvironmentOptions

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

EnvironmentRetentionPolicy

Nombre	Tipo	Description
daysToKeep	integer
releasesToKeep	integer
retainBuild	boolean

EnvironmentTrigger

Nombre	Tipo	Description
definitionEnvironmentId	integer
releaseDefinitionId	integer
triggerContent	string
triggerType	EnvironmentTriggerType

EnvironmentTriggerType

Nombre	Tipo	Description
deploymentGroupRedeploy	string
rollbackRedeploy	string
undefined	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.

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.

PropertiesCollection

La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object) excepto DBNull . Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.

Nombre	Tipo	Description
count	integer	Recuento de propiedades de la colección.
item	object
keys	string[]	Conjunto de claves de la colección.
values	string[]	Conjunto de valores de la colección.

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.

ReleaseDefinition

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene los vínculos a recursos, API y vistas relacionados para la definición de versión.
artifacts	Artifact[]	Obtiene o establece la lista de artefactos.
comment	string	Obtiene o establece el comentario.
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.
environments	ReleaseDefinitionEnvironment[]	Obtiene o establece la lista de entornos.
id	integer	Obtiene el identificador único de la definición de versión.
isDeleted	boolean	Si se elimina la definición de versión.
lastRelease	ReleaseReference	Obtiene la referencia de la última versión.
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 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.
properties	PropertiesCollection	Obtiene o establece propiedades.
releaseNameFormat	string	Obtiene o establece el formato de nombre de versión.
revision	integer	Obtiene el número de revisión.
source	ReleaseDefinitionSource	Obtiene o establece el origen de la definición de versión.
tags	string[]	Obtiene o establece la lista de etiquetas.
triggers	ReleaseTriggerBase[]	Obtiene o establece la lista de desencadenadores.
url	string	Obtiene la dirección URL de la API rest para acceder a la definición de versión.
variableGroups	integer[]	Obtiene o establece la lista de grupos de variables.
variables	<string,  ConfigurationVariableValue>	Obtiene o establece el diccionario de variables.

ReleaseDefinitionApprovals

Nombre	Tipo	Description
approvalOptions	ApprovalOptions
approvals	ReleaseDefinitionApprovalStep[]

ReleaseDefinitionApprovalStep

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

ReleaseDefinitionDeployStep

Nombre	Tipo	Description
id	integer
tasks	WorkflowTask[]	Lista de pasos para esta definición.

ReleaseDefinitionEnvironment

Nombre	Tipo	Description
badgeUrl	string
conditions	Condition[]
currentRelease	ReleaseShallowReference
demands	Demand[]
deployPhases	DeployPhase[]
deployStep	ReleaseDefinitionDeployStep
environmentOptions	EnvironmentOptions
environmentTriggers	EnvironmentTrigger[]
executionPolicy	EnvironmentExecutionPolicy	Define la directiva en cola del entorno en Release Management cola lateral. Enviaremos al ejecutor del entorno [creación de implementación previa y otros pasos] solo cuando se cumplan las directivas mencionadas.
id	integer
name	string
owner	IdentityRef
postDeployApprovals	ReleaseDefinitionApprovals
postDeploymentGates	ReleaseDefinitionGatesStep
preDeployApprovals	ReleaseDefinitionApprovals
preDeploymentGates	ReleaseDefinitionGatesStep
processParameters	ProcessParameters
properties	PropertiesCollection	La clase representa un contenedor de propiedades como una colección de pares clave-valor. Se aceptan valores de todos los tipos primitivos (cualquier tipo con un TypeCode != TypeCode.Object) excepto DBNull . Los valores de tipo Byte[], Int32, Double, DateType y String conservan su tipo; otros primitivos se vuelven a ajustar como string. Byte[] se esperaba como cadena codificada en base64.
queueId	integer
rank	integer
retentionPolicy	EnvironmentRetentionPolicy
schedules	ReleaseSchedule[]
variableGroups	integer[]
variables	<string,  ConfigurationVariableValue>

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.

ReleaseDefinitionSource

Obtiene o establece el origen de la definición de versión.

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

ReleaseReason

Obtiene el motivo de la versión.

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

ReleaseReference

Nombre	Tipo	Description
_links	ReferenceLinks	Obtiene vínculos para acceder a la versión.
artifacts	Artifact[]	Obtiene la lista de artefactos.
createdBy	IdentityRef	Obtiene la identidad que creó.
createdOn	string	Obtiene la fecha en la que se creó.
description	string	Obtiene la descripción.
id	integer	Obtiene el identificador único de este campo.
modifiedBy	IdentityRef	Obtiene la identidad que modificó.
name	string	Obtiene el nombre de la versión.
reason	ReleaseReason	Obtiene el motivo de la versión.
releaseDefinition	ReleaseDefinitionShallowReference	Obtiene la referencia superficial de la definición de versión.

ReleaseSchedule

Nombre	Tipo	Description
daysToRelease	ScheduleDays	Días de la semana que se van a publicar
jobId	string	Id. 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 que se va a iniciar
timeZoneId	string	Identificador de zona horaria de la programación de versión, 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 de REST para acceder a la versión.

ReleaseTriggerBase

Nombre	Tipo	Description
triggerType	ReleaseTriggerType

ReleaseTriggerType

Nombre	Tipo	Description
artifactSource	string
containerImage	string
package	string
pullRequest	string
schedule	string
sourceRepo	string
undefined	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

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