Compartir a través de

Definitions - Get

  • Referencia
Service:
Release
API Version:
7.1-preview.4

Obtenga una definición de versión.

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=7.1-preview.4
With optional parameters: 
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?propertyFilters={propertyFilters}&api-version=7.1-preview.4

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 "7.1-preview.4" 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 carpetas, versiones, definiciones de versión y entorno de versión.

Ejemplos

Get a release definition

Sample Request

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

Sample Response

Status code:
200 
{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdOn": "2018-12-11T04:48:42.657Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T04:48:42.657Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 40,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 118
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 119
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 120
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/40/40"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 40,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/40"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=40"
    }
  }
}

Definiciones

Nombre Description
ApprovalExecutionOrder

Orden de ejecución de aprobaciones.
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

Indica el tipo de fase de implementación.
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

Obtiene o establece el tipo de desencadenador.
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

Tipo de desencadenador de versión.
ScheduleDays

Días de la semana que se van a publicar.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Orden de ejecución de aprobaciones.

Nombre Tipo Description
afterGatesAlways

string

Las aprobaciones que se muestran siempre después de la ejecución de puertas.
afterSuccessfulGates

string

Aprobaciones que se muestran después de la ejecución correcta de puertas.
beforeGates

string

Aprobaciones mostradas antes de las puertas.

ApprovalOptions

Nombre Tipo Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

Especifique si la aprobación se puede omitir si el mismo aprobador aprobó la fase anterior.
enforceIdentityRevalidation

boolean

Especifique si vuelve a validar la identidad del aprobador antes de completar la aprobación.
executionOrder

ApprovalExecutionOrder

Orden de ejecución de aprobaciones.
releaseCreatorCanBeApprover

boolean

Especifique si el usuario que solicita una versión o una implementación debe permitir el aprobador.
requiredApproverCount

integer

Número de aprobaciones necesarias para avanzar la versión. '0' significa todas las aprobaciones necesarias.
timeoutInMinutes

integer

Tiempo de espera de aprobación. El tiempo de espera predeterminado de aprobación es de 30 días. El tiempo de espera máximo permitido es de 365 días. "0" significa tiempo de espera predeterminado, es decir, 30 días.

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

Indica si el artefacto es principal o no.
isRetained

boolean

Indica si el artefacto se conserva por versión o no.
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

Identificador del origen del artefacto.
name

string

Nombre del origen del artefacto.

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 y 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 y 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.
requestContent

string

Obtiene o establece el cuerpo de la solicitud HTTP.
requestVerb

string

Obtiene o establece el verbo de solicitud http.
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

Obtiene y establece el nombre de la demanda.
value

string

Obtiene y establece el valor de la demanda.

DeployPhase

Nombre Tipo Description
name

string

Obtiene y establece el nombre de la fase de implementación.
phaseType

DeployPhaseTypes

Indica el tipo de fase de implementación.
rank

integer

Obtiene y establece la clasificación de la fase de implementación.
refName

string

Obtiene y establece el nombre de referencia de la fase de implementación.
workflowTasks

WorkflowTask[]

Obtiene y establece las tareas de flujo de trabajo para la fase de implementación.

DeployPhaseTypes

Indica el tipo de fase de implementación.

Nombre Tipo Description
agentBasedDeployment

string

Tipo de fase que contiene las tareas ejecutadas en el agente.
deploymentGates

string

Tipo de fase que contiene tareas que actúan como Puertas para que la implementación avance.
machineGroupBasedDeployment

string

Tipo de fase que contiene las tareas ejecutadas en las máquinas del grupo de implementación.
runOnServer

string

Tipo de fase que contiene las tareas ejecutadas por el servidor.
undefined

string

Tipo de fase no definido. No use este parámetro.

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

Obtiene y establece como elementos de trabajo de vínculo automático o no.
badgeEnabled

boolean

Obtiene y establece como distintivo habilitado o no.
publishDeploymentStatus

boolean

Obtiene y establece como estado de implementación de publicación o no.
pullRequestDeploymentEnabled

boolean

Obtiene y establece como la implementación de la solicitud de incorporación de cambios habilitada o no.

EnvironmentRetentionPolicy

Nombre Tipo Description
daysToKeep

integer

Obtiene y establece el número de días que se conservará el entorno.
releasesToKeep

integer

Obtiene y establece el número de versiones que se van a conservar.
retainBuild

boolean

Obtiene y establece como la compilación que se va a conservar o no.

EnvironmentTrigger

Nombre Tipo Description
definitionEnvironmentId

integer

Identificador de entorno de definición en el que se aplica este desencadenador.
releaseDefinitionId

integer

ReleaseDefinition ID en el que se aplica este desencadenador.
triggerContent

string

Obtiene o establece el contenido del desencadenador.
triggerType

EnvironmentTriggerType

Obtiene o establece el tipo de desencadenador.

EnvironmentTriggerType

Obtiene o establece el tipo de desencadenador.

Nombre Tipo Description
deploymentGroupRedeploy

string

El tipo de desencadenador de entorno es la reimplementación del grupo de implementación.
rollbackRedeploy

string

El tipo de desencadenador de entorno es Rollback.
undefined

string

Tipo de desencadenador de entorno no definido.

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

En desuso: se puede recuperar consultando el usuario de Graph al que se hace referencia en la entrada "self" del diccionario IdentityRef "_links".
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

En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef
inactive

boolean

En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links".
isAadIdentity

boolean

En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName

string

En desuso: use Domain+PrincipalName en su lugar.
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.

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

Obtiene o establece las opciones de aprobación.
approvals

ReleaseDefinitionApprovalStep[]

Obtiene o establece las aprobaciones.

ReleaseDefinitionApprovalStep

Nombre Tipo Description
approver

IdentityRef

Obtiene y establece el aprobador.
id

integer

Identificador del paso de aprobación o implementación.
isAutomated

boolean

Indica si la aprobación está automatizada.
isNotificationOn

boolean

Indica si el conjunto de notificaciones de aprobación.
rank

integer

Obtiene o establece el rango del paso de aprobación.

ReleaseDefinitionDeployStep

Nombre Tipo Description
id

integer

Identificador del paso de aprobación o implementación.
tasks

WorkflowTask[]

Lista de pasos para esta definición.

ReleaseDefinitionEnvironment

Nombre Tipo Description
badgeUrl

string

Obtiene o establece badgeUrl. BadgeUrl se usará cuando se habilite el distintivo en el entorno de definición de versión.
conditions

Condition[]

Obtiene o establece las condiciones del entorno.
currentRelease

ReleaseShallowReference

Obtiene o establece la referencia de versión actual.
demands

Demand[]

Obtiene o establece las demandas.
deployPhases

DeployPhase[]

Obtiene o establece las fases de implementación del entorno.
deployStep

ReleaseDefinitionDeployStep

Obtiene o establece el objeto deploystep.
environmentOptions

EnvironmentOptions

Obtiene o establece las opciones de entorno.
environmentTriggers

EnvironmentTrigger[]

Obtiene o establece los desencadenadores en el entorno.
executionPolicy

EnvironmentExecutionPolicy

Obtiene o establece la directiva de ejecución del entorno.
id

integer

Obtiene y establece el identificador del entorno ReleaseDefinitionEnvironment.
name

string

Obtiene y establece el nombre de ReleaseDefinitionEnvironment.
owner

IdentityRef

Obtiene y establece el propietario de ReleaseDefinitionEnvironment.
postDeployApprovals

ReleaseDefinitionApprovals

Obtiene o establece las aprobaciones posteriores a la implementación.
postDeploymentGates

ReleaseDefinitionGatesStep

Obtiene o establece las puertas posteriores a la implementación.
preDeployApprovals

ReleaseDefinitionApprovals

Obtiene o establece las aprobaciones previas a la implementación.
preDeploymentGates

ReleaseDefinitionGatesStep

Obtiene o establece las puertas de implementación previa.
processParameters

ProcessParameters

Obtiene o establece los parámetros del proceso de entorno.
properties

PropertiesCollection

Obtiene o establece las propiedades en el entorno.
queueId

integer

Obtiene o establece el identificador de cola.
rank

integer

Obtiene y establece la clasificación de ReleaseDefinitionEnvironment.
retentionPolicy

EnvironmentRetentionPolicy

Obtiene o establece la directiva de retención del entorno.
schedules

ReleaseSchedule[]

Obtiene o establece las programaciones.
variableGroups

integer[]

Obtiene o establece los grupos de variables.
variables

<string,  ConfigurationVariableValue>

Obtiene y establece las variables.

ReleaseDefinitionGate

Nombre Tipo Description
tasks

WorkflowTask[]

Obtiene o establece el flujo de trabajo de puertas.

ReleaseDefinitionGatesOptions

Nombre Tipo Description
isEnabled

boolean

Obtiene o establece como puertas habilitadas o no.
minimumSuccessDuration

integer

Obtiene o establece la duración mínima de los resultados constantes después de una evaluación correcta de las puertas.
samplingInterval

integer

Obtiene o establece el tiempo entre la reevaluación de las puertas.
stabilizationTime

integer

Obtiene o establece el retraso antes de la evaluación.
timeout

integer

Obtiene o establece el tiempo de espera después del cual se produce un error en las puertas.

ReleaseDefinitionGatesStep

Nombre Tipo Description
gates

ReleaseDefinitionGate[]

Obtiene o establece las puertas.
gatesOptions

ReleaseDefinitionGatesOptions

Obtiene o establece las opciones de puerta.
id

integer

Id. de ReleaseDefinitionGateStep.

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

Indica ReleaseDefinition creado a partir de Ibiza.
portalExtensionApi

string

Indica ReleaseDefinition creado a partir de PortalExtension API.
restApi

string

Indica ReleaseDefinition creado mediante la API REST.
undefined

string

Indica el origen ReleaseDefinition no definido.
userInterface

string

Indica ReleaseDefinition creado mediante la interfaz de usuario.

ReleaseReason

Obtiene el motivo de la versión.

Nombre Tipo Description
continuousIntegration

string

Indica la versión desencadenada por la integración continua.
manual

string

Indica la versión desencadenada manualmente.
none

string

Indica el motivo desencadenado por la versión que no se ha establecido.
pullRequest

string

Indica la versión desencadenada por PullRequest.
schedule

string

Indica la versión desencadenada por programación.

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ó la versión.
createdOn

string

Obtiene la fecha en que se creó esta versión.
description

string

Obtiene la descripción.
id

integer

Identificador de la versión.
modifiedBy

IdentityRef

Obtiene la identidad que modificó la versión.
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.
scheduleOnlyWithChanges

boolean

Marca para determinar si esta programación solo debe liberarse si se ha cambiado el artefacto asociado o se ha cambiado la definición de versión.
startHours

integer

Hora de zona horaria local que se va a iniciar.
startMinutes

integer

Minuto de zona horaria local que se va a iniciar.
timeZoneId

string

Id. 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

Tipo de desencadenador de versión.

ReleaseTriggerType

Tipo de desencadenador de versión.

Nombre Tipo Description
artifactSource

string

Desencadenador de versión basado en artefactos.
containerImage

string

Desencadenador de versión basado en imágenes de contenedor.
package

string

Desencadenador de versión basado en paquetes.
pullRequest

string

Desencadenador de versión basado en solicitudes de incorporación de cambios.
schedule

string

Desencadenador de versión basado en programación.
sourceRepo

string

Desencadenador de versión basado en el repositorio de origen.
undefined

string

Tipo de desencadenador de versión no establecido.

ScheduleDays

Días de la semana que se van a publicar.

Nombre Tipo Description
all

string

Programado en todos los días de la semana.
friday

string

Programado el viernes.
monday

string

Programado el lunes.
none

string

No se ha establecido el día programado.
saturday

string

Programado el sábado.
sunday

string

Programado el domingo.
thursday

string

Programado el jueves.
tuesday

string

Programado el martes.
wednesday

string

Programado el miércoles.

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

Obtiene o establece como la tarea siempre se ejecuta o no.
condition

string

Obtiene o establece la condición de tarea.
continueOnError

boolean

Obtiene o establece cuando la tarea continúa ejecutándose en caso de error o no.
definitionType

string

Obtiene o establece el tipo de definición de tarea. Ejemplo: "Agent", DeploymentGroup", "Server" o "ServerGate".
enabled

boolean

Obtiene o establece como la tarea habilitada o no.
environment

object

Obtiene o establece las variables de entorno de tareas.
inputs

object

Obtiene o establece las entradas de la tarea.
name

string

Obtiene o establece el nombre de la tarea.
overrideInputs

object

Obtiene o establece las entradas de invalidación de la tarea.
refName

string

Obtiene o establece el nombre de referencia de la tarea.
retryCountOnTaskFailure

integer

Obtiene o establece el valor retryCount de la tarea.
taskId

string

Obtiene o establece el identificador de la tarea.
timeoutInMinutes

integer

Obtiene o establece el tiempo de espera de la tarea.
version

string

Obtiene o establece la versión de la tarea.