Usar variables predefinidas
Variables del agente (DevOps Services)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Esta variable tiene el mismo valor que Por ejemplo: |
| Agent.ContainerMapping |
Asignación de nombres de recursos de contenedor en YAML a sus identificadores de Docker en tiempo de ejecución. Por ejemplo: |
| Agent.HomeDirectory | Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo: c:\agent. |
| Agent.Id | Id. del agente. |
| Agent.JobName | Nombre del trabajo en ejecución. Normalmente será "Trabajo" o "__default", pero en escenarios de varias configuraciones, será la configuración. |
| Agent.JobStatus | Estado de la compilación.
Se debe hacer referencia a la variable de entorno como |
| Agent.MachineName | Nombre de la máquina en la que está instalado el agente. |
| Agent.Name |
Nombre del agente registrado en el grupo. Si usa un agente auto-hospedado, el usuario especifica este nombre. Vea agentes. |
| Agent.OS |
Sistema operativo del host del agente. Los valores válidos son:
|
| Agent.OSArchitecture |
Arquitectura del procesador del sistema operativo del host del agente. Los valores válidos son:
|
| Agent.TempDirectory |
Una carpeta temporal que se limpia después de cada trabajo de canalización. Este directorio lo usan tareas como CLI de .NET Core para contener elementos temporales, como los resultados de pruebas, antes de publicarlos. Por ejemplo: |
| Agent.ToolsDirectory |
Directorio utilizado por tareas como el Instalador de herramientas de Nodo y Usar la versión de Python para cambiar entre varias versiones de una herramienta.
Estas tareas agregarán herramientas desde este directorio a PATH para que los pasos de compilación posteriores puedan usarlas.
Obtenga información sobre cómo administrar este directorio en un agente auto-hospedado. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
Nota: No se garantiza que las tareas de canalización puedan escribir este directorio (por ejemplo, cuando se asigna a un contenedor) |
Variables de compilación (DevOps Services)
| Variable | Descripción | ¿Está disponible en plantillas? |
|---|---|---|
| Build.ArtifactStagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
No |
| Build.BuildId | Identificador del registro de la compilación completada. | No |
| Build.BuildNumber | Nombre de la compilación completada, también conocido como número de ejecución. Puede especificar lo que se incluye en este valor. Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
No |
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.BinariesDirectory | La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: c:\agent_work\1\b.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.ContainerId | Identificador del contenedor para el artefacto. Al cargar un artefacto en la canalización, se agrega a un contenedor específico para ese artefacto concreto. | No |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.DefinitionVersion | Versión de la canalización de compilación. | Sí |
| Build.QueuedBy | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.QueuedById | Vea"How are the identity variables set?". | Sí |
| Build.Reason | Evento que provocó la ejecución de la compilación.
|
Sí |
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Nota importante: Si des check out only one Git repository , esta ruta de acceso será la ruta de acceso exacta al código. Si consulta varios repositorios, el comportamiento es el siguiente (y puede diferir del valor de la variable Build.SourcesDirectory):
|
No |
| Build.Repository.ID | Identificador único del repositorio.
Esto no cambiará, aunque el nombre del repositorio sí lo haga. Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Name | Nombre del repositorio desencadenador.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Provider | Tipo del repositorio desencadenador.
|
No |
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Uri | Dirección URL del repositorio de desencadenamiento. Por ejemplo: Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. | No |
| Build.RequestedFor | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.RequestedForEmail | Vea"How are the identity variables set?". | Sí |
| Build.RequestedForId | Vea"How are the identity variables set?". | Sí |
| Build.SourceBranch | Rama del repositorio desencadenador para el que se ha en cola la compilación. He aquí algunos ejemplos:
/ ) se reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de alachas, no puede usar esta variable en el formato de número de compilación. |
Sí |
| Build.SourceBranchName | Nombre de la rama en el repositorio desencadenador para el que se ha en cola la compilación.
|
Sí |
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Nota importante: Si des check out only one Git repository (Solo un repositorio de Git), esta ruta de acceso será la ruta de acceso exacta al código. Si desprotego varios repositorios, se revertirá a su valor predeterminado, que es , incluso si el repositorio self (principal) se desprotede a una ruta de acceso personalizada diferente de su ruta de acceso predeterminada de desprotección múltiple (en este sentido, la variable difiere del comportamiento de la |
No |
| Build.SourceVersion | El último cambio de control de versiones del repositorio de desencadenamiento que se incluye en esta compilación.
|
Sí |
| Build.SourceVersionMessage | Comentario de la confirmación o el conjunto de cambios para el repositorio de desencadenadores. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
corresponde Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Además, esta variable solo está disponible en el nivel de paso y no está disponible en el trabajo ni en los niveles de fase (es decir, el mensaje no se extrae hasta que el trabajo se ha iniciado y desprotegido el código). Nota: Esta variable está disponible en TFS 2015.4. |
No |
| Build.StagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
No |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para Los submódulos de finalización de la compra en la pestaña del repositorio. Con varios repositorios desproteados, este valor realiza un seguimiento de la configuración del repositorio desencadenador.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjunto de adosados, se establece en el nombre del conjunto de cambios que está compilando. Nota: Esta variable produce un valor que no es válido para el uso de compilación en un formato de número de compilación. |
No |
| Build.TriggeredBy.BuildId | Si otra compilación desencadenóla compilación , esta variable se establece en buildID de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Si está desencadenando una canalización de YAML mediante resources , debe usar las variables de recursos en resources lugar.
|
No |
| Build.TriggeredBy.DefinitionId | Si otra compilación desencadenóla compilación , esta variable se establece en definitionID de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Si está desencadenando una canalización de YAML mediante resources , debe usar las variables de recursos en resources lugar.
|
No |
| Build.TriggeredBy.DefinitionName | Si otra compilación desencadenóla compilación , esta variable se establece en el nombre de la canalización de compilación desencadenada. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Si está desencadenando una canalización de YAML mediante resources , debe usar las variables de recursos en resources lugar.
|
No |
| Build.TriggeredBy.BuildNumber | Si otra compilación desencadenóla compilación , esta variable se establece en el número de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Si está desencadenando una canalización de YAML mediante resources , debe usar las variables de recursos en resources lugar.
|
No |
| Build.TriggeredBy.ProjectID | Si otra compilación desencadenóla compilación , esta variable se establece en id. del proyecto que contiene la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Si está desencadenando una canalización de YAML mediante resources , debe usar las variables de recursos en resources lugar.
|
No |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
Variables de canalización (DevOps Services)
| Variable | Descripción |
|---|---|
| Pipeline.Workspace | Directorio del área de trabajo para una canalización determinada. Esta variable tiene el mismo valor que Agent.BuildDirectory .Por ejemplo, /home/vsts/work/1. |
Variables de trabajo de implementación (DevOps Services)
Estas variables tienen como ámbito un trabajo de implementación específico y solo se resolverán en tiempo de ejecución del trabajo.
| Variable | Descripción |
|---|---|
| Environment.Name | Nombre del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación y registrar el historial de implementación. Por ejemplo, smarthotel-dev. |
| Environment.Id | Identificador del entorno de destino en el trabajo de implementación. Por ejemplo, 10. |
| Environment.ResourceName | Nombre del recurso específico dentro del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación y registrar el historial de implementación. Por ejemplo, bookings que es un espacio de nombres de Kubernetes que se ha agregado como un recurso al entorno smarthotel-dev . |
| Environment.ResourceId | Identificador del recurso específico dentro del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación. Por ejemplo, 4. |
| Strategy.Name | Nombre de la estrategia de implementación: canary , runOnce o rolling . |
| Strategy.CycleName | Nombre del ciclo actual en una implementación. Las opciones PreIteration son Iteration , o PostIteration . |
Variables del sistema (DevOps Services)
| Variable | Descripción | ¿Está disponible en plantillas? |
|---|---|---|
| System.AccessToken | Use el token de OAuth para acceder a la API REST.
Use System.AccessToken desde scripts YAML. Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Sí |
| System.CollectionId | GUID de la colección de TFS o Azure DevOps organización. | Sí |
| System.CollectionUri | Uri de la colección de TFS o Azure DevOps organización. Por ejemplo: https://dev.azure.com/fabrikamfiber/. |
Sí |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
No |
| System.DefinitionId | Identificador de la canalización de compilación. | Sí |
| System.HostType | Establezca en build si la canalización es una compilación. Para una versión, los valores son para un trabajo de grupo de implementación, durante la evaluación de puertas y para otros deploymentgates trabajos release (agente y sin agente). |
Sí |
| System.JobAttempt | Se establece en 1 la primera vez que se intenta este trabajo y se incrementa cada vez que se vuelve a intentar el trabajo. | No |
| System.JobDisplayName | Nombre legible que se da a un trabajo. | No |
| System.JobId | Identificador único para un único intento de un único trabajo. El valor es único para la canalización actual. | No |
| System.JobName | Nombre del trabajo, que normalmente se usa para expresar dependencias y acceder a variables de salida. | No |
| System.PhaseAttempt | Se establece en 1 la primera vez que se intenta esta fase y se incrementa cada vez que se vuelve a intentar el trabajo. Nota: "Fase" es un concepto principalmente redundante que representa el tiempo de diseño de un trabajo (mientras que el trabajo era la versión en tiempo de ejecución de una fase). Hemos quitado principalmente el concepto de "fase" de Azure Pipelines. Los trabajos de matriz y de configuración múltiple son el único lugar en el que la "fase" sigue siendo distinta de "job". Una fase puede crear instancias de varios trabajos que solo difieren en sus entradas. |
No |
| System.PhaseDisplayName | Nombre legible que se da a una fase. | No |
| System.PhaseName | Identificador basado en cadena para un trabajo, que normalmente se usa para expresar dependencias y acceder a variables de salida. | No |
| System.StageAttempt | Se establece en 1 la primera vez que se intenta esta fase y se incrementa cada vez que se vuelve a intentar el trabajo. | No |
| System.StageDisplayName | Nombre legible que se da a una fase. | No |
| System.StageName | Identificador basado en cadena para una fase, que normalmente se usa para expresar dependencias y acceder a variables de salida. | Sí |
| System.PullRequest.IsFork | Si la solicitud de extracción es de una bifurcación del repositorio, esta variable se establece en True .
De lo contrario, se establece en False . |
Sí |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que provocó esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
No |
| System.PullRequest.PullRequestNumber | Número de la solicitud de extracción que provocó esta compilación. Esta variable se rellena para las solicitudes de extracción de GitHub que tienen un identificador de solicitud de extracción y un número de solicitud de extracción diferentes. Esta variable solo está disponible en una canalización de YAML si la solicitud de cambio se ve afectada por una directiva de rama. | No |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature para Azure Repos. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). Esta variable solo está disponible en una canalización de YAML si la solicitud de cambio se ve afectada por una directiva de rama. |
No |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: https://dev.azure.com/ouraccount/_git/OurProject. |
No |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master cuando el repositorio está en Azure Repos y cuando el repositorio está en master GitHub. Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama. Esta variable solo está disponible en una canalización de YAML si la solicitud de cambio se ve afectada por una directiva de rama. |
No |
| System.TeamFoundationCollectionUri | Uri de la colección de TFS o Azure DevOps organización. Por ejemplo: https://dev.azure.com/fabrikamfiber/.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Sí |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. | Sí |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. | Sí |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
Comprueba las variables (DevOps Services)
| Variable | Descripción |
|---|---|
| Checks.StageAttempt | Se establece en 1 la primera vez que se intenta esta fase y se incrementa cada vez que se vuelve a intentar la fase.
Esta variable solo se puede usar dentro de una aprobación o comprobar un entorno. Por ejemplo, puede usar dentro de $(Checks.StageAttempt) una comprobación de la API REST $(Checks.StageAttempt). |
Variables del agente (DevOps Server 2020)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Esta variable tiene el mismo valor que Por ejemplo: |
| Agent.HomeDirectory | Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo: c:\agent. |
| Agent.Id | Id. del agente. |
| Agent.JobName | Nombre del trabajo en ejecución. Normalmente será "Trabajo" o "__default", pero en escenarios de varias configuraciones, será la configuración. |
| Agent.JobStatus | Estado de la compilación.
Se debe hacer referencia a la variable de entorno como |
| Agent.MachineName | Nombre de la máquina en la que está instalado el agente. |
| Agent.Name |
Nombre del agente registrado en el grupo. Si usa un agente auto-hospedado, el usuario especifica este nombre. Vea agentes. |
| Agent.OS |
Sistema operativo del host del agente. Los valores válidos son:
|
| Agent.OSArchitecture |
Arquitectura del procesador del sistema operativo del host del agente. Los valores válidos son:
|
| Agent.TempDirectory |
Una carpeta temporal que se limpia después de cada trabajo de canalización. Este directorio lo usan tareas como CLI de .NET Core para contener elementos temporales, como los resultados de pruebas, antes de publicarlos. Por ejemplo: |
| Agent.ToolsDirectory |
Directorio utilizado por tareas como el Instalador de herramientas de Nodo y Usar la versión de Python para cambiar entre varias versiones de una herramienta.
Estas tareas agregarán herramientas desde este directorio a PATH para que los pasos de compilación posteriores puedan usarlas.
Obtenga información sobre cómo administrar este directorio en un agente auto-hospedado. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
Nota: No se garantiza que las tareas de canalización puedan escribir este directorio (por ejemplo, cuando se asigna a un contenedor) |
Variables de compilación (DevOps Server 2020)
| Variable | Descripción | ¿Está disponible en plantillas? |
|---|---|---|
| Build.ArtifactStagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
No |
| Build.BuildId | Identificador del registro de la compilación completada. | No |
| Build.BuildNumber | Nombre de la compilación completada, también conocido como número de ejecución. Puede especificar lo que se incluye en este valor. Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
No |
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.BinariesDirectory | La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: c:\agent_work\1\b.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.ContainerId | Identificador del contenedor para el artefacto. Cuando se carga un artefacto en la canalización, se agrega a un contenedor específico para ese artefacto concreto. | No |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.DefinitionVersion | Versión de la canalización de compilación. | Sí |
| Build.QueuedBy | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.QueuedById | Vea"How are the identity variables set?". | Sí |
| Build.Reason | Evento que provocó la ejecución de la compilación.
|
Sí |
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Nota importante: Si des check out only one Git repository , esta ruta de acceso será la ruta de acceso exacta al código. Si consulta varios repositorios, el comportamiento es el siguiente (y puede diferir del valor de la variable Build.SourcesDirectory):
|
No |
| Build.Repository.ID | Identificador único del repositorio.
Esto no cambiará, aunque el nombre del repositorio sí lo haga. Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Name | Nombre del repositorio desencadenador.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Provider | Tipo del repositorio desencadenador.
|
No |
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
| Build.Repository.Uri | Dirección URL del repositorio de desencadenamiento. Por ejemplo: Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. | No |
| Build.RequestedFor | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
Sí |
| Build.RequestedForEmail | Vea"¿Cómo se establecen las variables de identidad?". | Sí |
| Build.RequestedForId | Vea"¿Cómo se establecen las variables de identidad?". | Sí |
| Build.SourceBranch | Rama del repositorio desencadenador para el que se ha en cola la compilación. He aquí algunos ejemplos:
/ reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de cambios, no puede usar esta variable en el formato de número de compilación. |
Sí |
| Build.SourceBranchName | Nombre de la rama en el repositorio de desencadenamiento para el que se ha en cola la compilación.
|
Sí |
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Nota importante: Si des check out only one Git repository (Solo un repositorio de Git), esta ruta de acceso será la ruta de acceso exacta al código. Si desprotego varios repositorios, se revertirá a su valor predeterminado, que es , incluso si el repositorio self (principal) se desprotede a una ruta de acceso personalizada diferente de su ruta de acceso predeterminada de desprotección múltiple (en este sentido, la variable difiere del comportamiento de la |
No |
| Build.SourceVersion | El último cambio de control de versiones del repositorio de desencadenamiento que se incluye en esta compilación.
|
Sí |
| Build.SourceVersionMessage | Comentario de la confirmación o el conjunto de cambios para el repositorio de desencadenadores. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Además, esta variable solo está disponible en el nivel de paso y no está disponible en el trabajo ni en los niveles de fase (es decir, el mensaje no se extrae hasta que el trabajo se ha iniciado y desprotegido el código). Nota: Esta variable está disponible en TFS 2015.4. |
No |
| Build.StagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
No |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para Los submódulos de finalización de la compra en la pestaña del repositorio. Con varios repositorios desproteados, este valor realiza un seguimiento de la configuración del repositorio desencadenador.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjunto de adosados, se establece en el nombre del conjunto de cambios que está compilando. Nota: Esta variable produce un valor que no es válido para el uso de compilación en un formato de número de compilación. |
No |
| Build.TriggeredBy.BuildId | Si otra compilación desencadenóla compilación , esta variable se establece en buildID de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.TriggeredBy.DefinitionId | Si otra compilación desencadenóla compilación , esta variable se establece en definitionID de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.TriggeredBy.DefinitionName | Si otra compilación desencadenóla compilación , esta variable se establece en el nombre de la canalización de compilación desencadenada. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.TriggeredBy.BuildNumber | Si otra compilación desencadenóla compilación , esta variable se establece en el número de la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Build.TriggeredBy.ProjectID | Si otra compilación desencadenóla compilación , esta variable se establece en id. del proyecto que contiene la compilación desencadenante. En las canalizaciones clásicas, esta variable se desencadena mediante un desencadenador de finalización de compilación.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
No |
Variables de canalización (DevOps Server 2020)
| Variable | Descripción |
|---|---|
| Pipeline.Workspace | Directorio del área de trabajo para una canalización determinada. Esta variable tiene el mismo valor que Agent.BuildDirectory .Por ejemplo, /home/vsts/work/1. |
Variables de trabajo de implementación (DevOps Server 2020)
Estas variables tienen como ámbito un trabajo de implementación específico y solo se resolverán en tiempo de ejecución del trabajo.
| Variable | Descripción |
|---|---|
| Environment.Name | Nombre del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación y registrar el historial de implementación. Por ejemplo, smarthotel-dev. |
| Environment.Id | Identificador del entorno de destino en el trabajo de implementación. Por ejemplo, 10. |
| Environment.ResourceName | Nombre del recurso específico dentro del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación y registrar el historial de implementación. Por ejemplo, que es un espacio de nombres de bookings Kubernetes que se ha agregado como un recurso al entorno smarthotel-dev . |
| Environment.ResourceId | Identificador del recurso específico dentro del entorno de destino en el trabajo de implementación para ejecutar los pasos de implementación. Por ejemplo, 4. |
Variables del sistema (DevOps Server 2020)
| Variable | Descripción | ¿Está disponible en plantillas? |
|---|---|---|
| System.AccessToken | Use el token de OAuth para acceder a la API REST.
Use System.AccessToken desde scripts YAML. Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
Sí |
| System.CollectionId | Guid de la colección de TFS o Azure DevOps organización | Sí |
| System.CollectionUri | Una cadena que Team Foundation Server URI de colección. | Sí |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
No |
| System.DefinitionId | Identificador de la canalización de compilación. | Sí |
| System.HostType | Establezca en build si la canalización es una compilación. Para una versión, los valores son para un trabajo de grupo de implementación, durante la evaluación de puertas y para otros deploymentgates trabajos release (agente y sin agente). |
Sí |
| System.JobAttempt | Se establece en 1 la primera vez que se intenta este trabajo y se incrementa cada vez que se vuelve a intentar el trabajo. | No |
| System.JobDisplayName | Nombre legible que se da a un trabajo. | No |
| System.JobId | Identificador único para un único intento de un único trabajo. El valor es único para la canalización actual. | No |
| System.JobName | Nombre del trabajo, que normalmente se usa para expresar dependencias y acceder a variables de salida. | No |
| System.PhaseAttempt | Se establece en 1 la primera vez que se intenta esta fase y se incrementa cada vez que se vuelve a intentar el trabajo. Nota: "Fase" es un concepto principalmente redundante que representa el tiempo de diseño de un trabajo (mientras que el trabajo era la versión en tiempo de ejecución de una fase). Principalmente hemos quitado el concepto de "fase" de Azure Pipelines. Los trabajos de matriz y de configuración múltiple son el único lugar donde "phase" sigue siendo distinto de "job". Una fase puede crear instancias de varios trabajos que solo difieren en sus entradas. |
No |
| System.PhaseDisplayName | Nombre legible que se da a una fase. | No |
| System.PhaseName | Identificador basado en cadena para un trabajo, que normalmente se usa para expresar dependencias y acceder a variables de salida. | No |
| System.StageAttempt | Se establece en 1 la primera vez que se intenta esta fase y se incrementa cada vez que se vuelve a intentar el trabajo. | No |
| System.StageDisplayName | Nombre legible que se da a una fase. | No |
| System.StageName | Identificador basado en cadena para una fase, que normalmente se usa para expresar dependencias y acceder a variables de salida. | Sí |
| System.PullRequest.IsFork | Si la solicitud de extracción es de una bifurcación del repositorio, esta variable se establece en True .
De lo contrario, se establece en False . |
Sí |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que produjo esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
No |
| System.PullRequest.PullRequestNumber | Número de la solicitud de extracción que produjo esta compilación. Esta variable se rellena para las solicitudes de extracción de GitHub que tienen un identificador de solicitud de extracción y un número de solicitud de extracción diferentes. Esta variable solo está disponible en una canalización de YAML si la solicitud de cambio se ve afectada por una directiva de rama. | No |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). Esta variable solo está disponible en una canalización de YAML si la solicitud de cambios se ve afectada por una directiva de rama. |
No |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: https://dev.azure.com/ouraccount/_git/OurProject. |
No |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master cuando el repositorio está en Azure Repos y cuando el repositorio está en master GitHub. Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama. Esta variable solo está disponible en una canalización de YAML si la solicitud de cambios se ve afectada por una directiva de rama. |
No |
| System.TeamFoundationCollectionUri | Uri de la colección team foundation. Por ejemplo: https://dev.azure.com/fabrikamfiber/
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
Sí |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. | Sí |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. | Sí |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. |
No |
Variables del agente (DevOps Server 2019)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Por ejemplo: |
| Agent.HomeDirectory | Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo: c:\agent. |
| Agent.Id | Id. del agente. |
| Agent.JobName | Nombre del trabajo en ejecución. Suele ser "Trabajo" o "__default", pero en escenarios de varias configuraciones, será la configuración. |
| Agent.JobStatus | Estado de la compilación.
Se debe hacer referencia a la variable de entorno como |
| Agent.MachineName | Nombre de la máquina en la que está instalado el agente. |
| Agent.Name |
Nombre del agente registrado con el grupo. Si usa un agente auto-hospedado, el usuario especifica este nombre. Vea agentes. |
| Agent.OS |
Sistema operativo del host del agente. Los valores válidos son:
|
| Agent.OSArchitecture |
Arquitectura del procesador del sistema operativo del host del agente. Los valores válidos son:
|
| Agent.TempDirectory | Una carpeta temporal que se limpia después de cada trabajo de canalización. Este directorio lo usan tareas como CLI de .NET Core tarea para contener elementos temporales, como los resultados de pruebas, antes de publicarlos. |
| Agent.ToolsDirectory |
Directorio utilizado por tareas como el Instalador de herramientas de Nodo y Usar la versión de Python para cambiar entre varias versiones de una herramienta.
Estas tareas agregarán herramientas desde este directorio a PATH para que los pasos de compilación posteriores puedan usarlas.
Obtenga información sobre cómo administrar este directorio en un agente auto-hospedado. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
No se garantiza que las tareas de canalización puedan escribir este directorio (por ejemplo, cuando se asigna a un contenedor) |
Variables de compilación (DevOps Server 2019)
| Variable | Descripción |
|---|---|
| Build.ArtifactStagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.BuildId | Identificador del registro de la compilación completada. |
| Build.BuildNumber | Nombre de la compilación completada. Puede especificar el formato de número de compilación que genera este valor en las opciones de canalización.
Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.BinariesDirectory | La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: c:\agent_work\1\b.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.DefinitionVersion | La versión de la canalización de compilación. |
| Build.QueuedBy | Vea"¿Cómo se establecen las variables de identidad?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.QueuedById | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.Reason | Evento que provocó la ejecución de la compilación.
|
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.SourcesDirectory. |
| Build.Repository.Name | Nombre del repositorio.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Provider | Tipo de repositorio que seleccionó.
|
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Uri | Dirección URL del repositorio. Por ejemplo: Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.RequestedFor | Vea"¿Cómo se establecen las variables de identidad?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.RequestedForEmail | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.RequestedForId | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.SourceBranch | Rama para la que se ha en cola la compilación. He aquí algunos ejemplos:
/ reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de cambios, no puede usar esta variable en el formato de número de compilación. |
| Build.SourceBranchName | Nombre de la rama para la que se ha en cola la compilación.
|
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.Repository.LocalPath. |
| Build.SourceVersion | El último cambio de control de versiones que se incluye en esta compilación.
|
| Build.SourceVersionMessage | Comentario de la confirmación o el conjunto de cambios. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Nota: Esta variable está disponible en TFS 2015.4. |
| Build.StagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para los submódulos checkout en la pestaña del repositorio. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjuntode alachas , se establece en el nombre del conjunto de alaquetes que va a compilar. Nota: Esta variable produce un valor que no es válido para su uso en un formato de número de compilación. |
| Build.TriggeredBy.BuildId | Si otra compilación desencadenóla compilación , esta variable se establece en el Valor buildID de la compilación de desencadenamiento.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.TriggeredBy.DefinitionId | Si otra compilación desencadenóla compilación , esta variable se establece en definitionID de la compilación de desencadenamiento.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.TriggeredBy.DefinitionName | Si otra compilación desencadenóla compilación , esta variable se establece en el nombre de la canalización de compilación que desencadena.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.TriggeredBy.BuildNumber | Si otra compilación desencadenóla compilación , esta variable se establece en el número de la compilación desencadenante.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.TriggeredBy.ProjectID | Si otra compilación desencadenóla compilación , esta variable se establece en el identificador del proyecto que contiene la compilación de desencadenamiento.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del sistema (DevOps Server 2019)
| Variable | Descripción |
|---|---|
| System.AccessToken | Use el token de OAuth para acceder a la API REST.
Use System.AccessToken desde scripts YAML. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.CollectionId | Guid de la colección de TFS o Azure DevOps organización |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
| System.DefinitionId | Identificador de la canalización de compilación. |
| System.HostType | Establezca en build si la canalización es una compilación. Para una versión, los valores son deployment para un trabajo de grupo de implementación y para un trabajo del Agente release .
|
| System.PullRequest.IsFork | Si la solicitud de extracción es de una bifurcación del repositorio, esta variable se establece en True .
De lo contrario, se establece en False . |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que produjo esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama). |
| System.PullRequest.PullRequestNumber | Número de la solicitud de extracción que produjo esta compilación. Esta variable se rellena para las solicitudes de extracción de GitHub que tienen un identificador de solicitud de extracción y un número de solicitud de extracción diferentes. |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: https://dev.azure.com/ouraccount/_git/OurProject. (Esta variable solo se inicializa si la compilación se ejecutó debido a una Azure Repos pr. de Git afectada por una directiva de rama. No se inicializa para los GitHub de datos). |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master. Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama. |
| System.TeamFoundationCollectionUri | Uri de la colección team foundation. Por ejemplo: https://dev.azure.com/fabrikamfiber/.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del agente (TFS 2018)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Por ejemplo: |
| Agent.HomeDirectory | Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo: c:\agent. |
| Agent.Id | Id. del agente. |
| Agent.JobStatus | Estado de la compilación.
Se debe hacer referencia a la variable de entorno como |
| Agent.MachineName | Nombre de la máquina en la que está instalado el agente. |
| Agent.Name |
Nombre del agente registrado en el grupo. El usuario especifica este nombre. Vea agentes. |
| Agent.TempDirectory | Una carpeta temporal que se limpia después de cada trabajo de canalización. Este directorio lo usan tareas como CLI de .NET Core para contener elementos temporales, como los resultados de pruebas, antes de publicarlos. |
| Agent.ToolsDirectory |
Directorio utilizado por tareas como el Instalador de herramientas de Nodo y Usar la versión de Python para cambiar entre varias versiones de una herramienta.
Estas tareas agregarán herramientas desde este directorio a PATH para que los pasos de compilación posteriores puedan usarlas.
Obtenga información sobre cómo administrar este directorio en un agente auto-hospedado. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
|
Variables de compilación (TFS 2018)
| Variable | Descripción |
|---|---|
| Build.ArtifactStagingDirectory | Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino.
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.BuildId | Identificador del registro de la compilación completada. |
| Build.BuildNumber | Nombre de la compilación completada. Puede especificar el formato de número de compilación que genera este valor en las opciones de canalización.
Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.BinariesDirectory | La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: c:\agent_work\1\b.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.DefinitionVersion | Versión de la canalización de compilación. |
| Build.QueuedBy | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.QueuedById | Vea"How are the identity variables set?". |
| Build.Reason | Evento que provocó la ejecución de la compilación.
|
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.SourcesDirectory. |
| Build.Repository.Name | Nombre del repositorio.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Provider | Tipo de repositorio que seleccionó.
|
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Uri | Dirección URL del repositorio. Por ejemplo:
|
| Build.RequestedFor | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.RequestedForEmail | Vea"How are the identity variables set?". |
| Build.RequestedForId | Vea"How are the identity variables set?". |
| Build.SourceBranch | Rama para la que se ha en cola la compilación. He aquí algunos ejemplos:
/ ) se reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de alachas, no puede usar esta variable en el formato de número de compilación. |
| Build.SourceBranchName | Nombre de la rama para la que se ha en cola la compilación.
|
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.Repository.LocalPath. |
| Build.SourceVersion | El último cambio de control de versiones que se incluye en esta compilación.
|
| Build.SourceVersionMessage | Comentario de la confirmación o el conjunto de cambios. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como etiqueta de control de versiones. Nota: Esta variable está disponible en TFS 2015.4. |
| Build.StagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para Los submódulos de finalización de la compra en la pestaña del repositorio. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjunto de adosados, se establece en el nombre del conjunto de cambios que está compilando. Nota: Esta variable produce un valor que no es válido para el uso de compilación en un formato de número de compilación. |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del sistema (TFS 2018)
| Variable | Descripción |
|---|---|
| System.AccessToken | Use el token de OAuth para acceder a la API REST.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.CollectionId | Guid de la colección de TFS o Azure DevOps organización |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
| System.DefinitionId | Identificador de la canalización de compilación. |
| System.HostType | Establezca en build si la canalización es una compilación o si la canalización es una release versión. |
| System.PullRequest.IsFork | Si la solicitud de extracción es de una bifurcación del repositorio, esta variable se establece en True .
De lo contrario, se establece en False . Disponible en TFS 2018.2. |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que provocó esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/_git/OurProject. (Esta variable solo se inicializa si la compilación se ejecutó debido a una Azure Repos de git afectada por una directiva de rama). |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master. Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama. |
| System.TeamFoundationCollectionUri | Uri de la colección team foundation. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del agente (TFS 2017)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Por ejemplo: |
| Agent.ComputerName | Nombre de la máquina en la que está instalado el agente. |
| Agent.HomeDirectory | Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo: c:\agent. |
| Agent.Id | Id. del agente. |
| Agent.JobStatus | Estado de la compilación.
Se debe hacer referencia a la variable de entorno como |
| Agent.Name |
Nombre del agente registrado en el grupo. El usuario especifica este nombre. Vea agentes. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
|
Variables de compilación (TFS 2017)
| Variable | Descripción |
|---|---|
| Build.ArtifactStagingDirectory | Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino.
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.BuildId | Identificador del registro de la compilación completada. |
| Build.BuildNumber | Nombre de la compilación completada. Puede especificar el formato de número de compilación que genera este valor en las opciones de canalización.
Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.BinariesDirectory | La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: c:\agent_work\1\b.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.DefinitionVersion | La versión de la canalización de compilación. |
| Build.QueuedBy | Vea"¿Cómo se establecen las variables de identidad?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.QueuedById | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.Reason | Evento que provocó la ejecución de la compilación. Disponible en TFS 2017.3.
|
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.SourcesDirectory. |
| Build.Repository.Name | Nombre del repositorio.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Provider | Tipo de repositorio que seleccionó.
|
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Uri | Dirección URL del repositorio. Por ejemplo:
|
| Build.RequestedFor | Vea"¿Cómo se establecen las variables de identidad?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.RequestedForEmail | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.RequestedForId | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.SourceBranch | Rama para la que se ha en cola la compilación. He aquí algunos ejemplos:
/ reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de cambios, no puede usar esta variable en el formato de número de compilación. |
| Build.SourceBranchName | Nombre de la rama para la que se ha en cola la compilación.
|
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.Repository.LocalPath. |
| Build.SourceVersion | El último cambio de control de versiones que se incluye en esta compilación.
|
| Build.SourceVersionMessage | Comentario del conjunto de cambios o confirmación. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Nota: Esta variable está disponible en TFS 2015.4. |
| Build.StagingDirectory |
Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para Los submódulos de finalización de la compra en la pestaña del repositorio. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjunto de adosados, se establece en el nombre del conjunto de cambios que está compilando. Nota: Esta variable produce un valor que no es válido para el uso de compilación en un formato de número de compilación. |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del sistema (TFS 2017)
| Variable | Descripción |
|---|---|
| System.AccessToken | Use el token de OAuth para acceder a la API REST. |
| System.CollectionId | Guid de la colección de TFS o Azure DevOps organización |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
| System.DefinitionId | Identificador de la canalización de compilación. |
| System.HostType | Establezca en build si la canalización es una compilación o si la canalización es una release versión. |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que provocó esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature. (Esta variable solo se inicializa si la compilación se ejecutó debido a una PR de Git afectada por una directiva de rama). |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/_git/OurProject. (Esta variable solo se inicializa si la compilación se ejecutó debido a una Azure Repos de git afectada por una directiva de rama). |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master. Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama. |
| System.TeamFoundationCollectionUri | Uri de la colección team foundation. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del agente (TFS 2015)
Nota:
Puede usar variables de agente como variables de entorno en los scripts y como parámetros en las tareas de compilación. No se pueden usar para personalizar el número de compilación o para aplicar una etiqueta o etiqueta de control de versiones.
| Variable | Descripción |
|---|---|
| Agent.BuildDirectory |
Ruta de acceso local en el agente donde se crean todas las carpetas de una canalización de compilación determinada. Por ejemplo:
|
| Agent.HomeDirectory |
Directorio en el que está instalado el agente. Contiene el software del agente. Por ejemplo:
|
| Agent.Id | Id. del agente. |
| Agent.JobStatus | Estado de la compilación.
Nota: Solo se puede hacer referencia a la variable de entorno como . |
| Agent.MachineName | Nombre de la máquina en la que está instalado el agente. Esta variable está disponible en TFS 2015.4,no en TFS 2015 RTM. |
| Agent.Name |
Nombre del agente registrado con el grupo. El usuario especifica este nombre. Vea agentes. |
| Agent.WorkFolder |
Directorio de trabajo para este agente.
Por ejemplo: c:\agent_work.
|
Variables de compilación (TFS 2015)
| Variable | Descripción |
|---|---|
| Build.ArtifactStagingDirectory | Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino.
Una manera típica de usar esta carpeta es publicar los artefactos de compilación con las tareas Copiar archivos y Publicar artefactos de compilación. Vea Artifacts en Azure Pipelines. Por ejemplo:
En TFS 2015.4,Build.ArtifactStagingDirectory y Build.StagingDirectory son intercambiables. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.BuildId | Identificador del registro de la compilación completada. |
| Build.BuildNumber | Nombre de la compilación completada. Puede especificar el formato de número de compilación que genera este valor en las opciones de canalización.
Un uso típico de esta variable es convertirla en parte del formato de etiqueta, que se especifica en la pestaña del repositorio. Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta.
|
| Build.BuildUri | Uri de la compilación. Por ejemplo: vstfs:///Build/Build/1430.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.BinariesDirectory |
La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados. Disponible en TFS 2015.4.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. Por ejemplo: C:\TfsData\Agents\Agent-MACHINENAME_work\1\b
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.DefinitionName | Nombre de la canalización de compilación.
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.DefinitionVersion | Versión de la canalización de compilación. |
| Build.QueuedBy | Vea"How are the identity variables set?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.QueuedById | Vea"How are the identity variables set?". |
| Build.Repository.Clean | Valor que ha seleccionado para Limpiar en la configuración del repositorio de origen.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.LocalPath |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.SourcesDirectory. |
| Build.Repository.Name | Nombre del repositorio.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Provider | Tipo de repositorio que seleccionó.
|
| Build.Repository.Tfvc.Workspace | Se define si el repositorio está Control de versiones de Team Foundation. Nombre del área de trabajo de TFVC utilizada por el agente de compilación.
Por ejemplo, si Agent.BuildDirectory es y el Agent.Id es , el nombre del área c:\agent_work\128 de trabajo podría ser: ws_12_8
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Uri | Dirección URL del repositorio. Por ejemplo:
|
| Build.RequestedFor | Vea"¿Cómo se establecen las variables de identidad?".
Nota: Este valor puede contener espacios en blanco u otros caracteres de etiqueta no válidos. En estos casos, se producirá un error en el formato de etiqueta. |
| Build.RequestedForId | Vea"¿Cómo se establecen las variables de identidad?". |
| Build.SourceBranch | Rama para la que se ha en cola la compilación. He aquí algunos ejemplos:
/ reemplazan por caracteres de subrayado _ ).
Nota: En TFVC, si está ejecutando una compilación de check-in o compilando manualmente un conjunto de cambios, no puede usar esta variable en el formato de número de compilación. |
| Build.SourceBranchName | Nombre de la rama para la que se ha en cola la compilación.
|
| Build.SourcesDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: Esta variable es sinónimo de Build.Repository.LocalPath. |
| Build.SourcesDirectoryHash | Nota: Esta variable está disponible en TFS 2015 RTM, pero no en TFS 2015.4. |
| Build.SourceVersion | El último cambio de control de versiones que se incluye en esta compilación.
|
| Build.SourceVersionMessage | Comentario del conjunto de cambios o confirmación. Truncamos el mensaje a la primera línea o 200 caracteres, lo que sea más corto.
Esta variable tiene ámbito de agente y se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. Nota: Esta variable está disponible en TFS 2015.4. |
| Build.StagingDirectory |
TFS 2015 RTM
La ruta de acceso local del agente que puede usar como carpeta de salida para los archivos binarios compilados. Por ejemplo: C:\TfsData\Build_work\6c3842c6\staging.
De forma predeterminada, las nuevas canalizaciones de compilación no están configuradas para limpiar este directorio. Puede definir la compilación para limpiarla en la pestaña Repositorio. TFS 2015.4 Ruta de acceso local en el agente donde se copian los artefactos antes de insertarse en su destino. Por ejemplo: C:\TfsData\Agents\Agent-MACHINENAME_work\1\a
Este directorio se purga antes de cada nueva compilación, por lo que no tiene que limpiarlo usted mismo. Una manera típica de usar esta carpeta es publicar los artefactos de compilación con las tareas Copiar archivos y Publicar artefactos de compilación. Vea Artifacts en Azure Pipelines. En TFS 2015.4,Build.ArtifactStagingDirectory y Build.StagingDirectory son intercambiables. Todas las versiones de TFS 2015 Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.Repository.Git.SubmoduleCheckout | Valor que ha seleccionado para los submódulos checkout en la pestaña del repositorio. Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| Build.SourceTfvcShelveset | Se define si el repositorio está Control de versiones de Team Foundation.
Si está ejecutando una compilación compuerta o una compilación de conjuntode alachas , se establece en el nombre del conjunto de alaquetes que va a compilar. Nota: Esta variable produce un valor que no es válido para su uso en un formato de número de compilación. |
| Common.TestResultsDirectory | Ruta de acceso local en el agente donde se crean los resultados de la prueba. Por ejemplo: c:\agent_work\1\TestResults. Disponible en TFS 2015.4.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
Variables del sistema (TFS 2015)
| Variable | Descripción |
|---|---|
| System.AccessToken | Disponible en TFS 2015.4. Use el token de OAuth para acceder a la API REST.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.CollectionId | Guid de la colección de TFS o Azure DevOps organización |
| System.DefaultWorkingDirectory |
Ruta de acceso local en el agente donde se descargan los archivos de código fuente. Por ejemplo: |
| System.DefinitionId | Identificador de la canalización de compilación. |
| System.HostType | Establezca en build si la canalización es una compilación o si la canalización es una release versión. |
| System.PullRequest.PullRequestId | Identificador de la solicitud de extracción que produjo esta compilación. Por ejemplo: 17. (Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama). |
| System.PullRequest.SourceBranch | Rama que se está revisando en una solicitud de extracción. Por ejemplo: refs/heads/users/raisa/new-feature. (Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama). |
| System.PullRequest.SourceRepositoryURI | Dirección URL del repositorio que contiene la solicitud de extracción. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/_git/OurProject. (Esta variable solo se inicializa si la compilación se ejecutó debido a una Azure Repos de git afectada por una directiva de rama). |
| System.PullRequest.TargetBranch | Rama que es el destino de una solicitud de extracción. Por ejemplo: refs/heads/master. Esta variable solo se inicializa si la compilación se ejecutó debido a una pr. de Git afectada por una directiva de rama. |
| System.TeamFoundationCollectionUri | Uri de la colección team foundation. Por ejemplo: http://our-server:8080/tfs/DefaultCollection/.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
| System.TeamProject | Nombre del proyecto que contiene esta compilación. |
| System.TeamProjectId | Identificador del proyecto al que pertenece esta compilación. |
| TF_BUILD | Se establece True en si una tarea de compilación ejecuta el script.
Esta variable tiene ámbito de agente. Se puede usar como variable de entorno en un script y como parámetro en una tarea de compilación, pero no como parte del número de compilación o como una etiqueta de control de versiones. |
¿Cómo se establecen las variables de identidad?
El valor depende de lo que produjo la compilación y es específico de Azure Repos repositorios.
| Si se desencadena la compilación... | A continuación, los valores Build.QueuedBy y Build.QueuedById se basan en... | A continuación, los valores Build.RequestedFor y Build.RequestedForId se basan en... |
|---|---|---|
| En Git o TFVC mediante los desencadenadores de integración continua (CI) | La identidad del sistema, por ejemplo: [DefaultCollection]\Project Collection Service Accounts |
La persona que instó o registró los cambios. |
| En Git o mediante una compilación de directiva de rama. | La identidad del sistema, por ejemplo: [DefaultCollection]\Project Collection Service Accounts |
La persona que registró los cambios. |
| En TFVC mediante un desencadenador de registro por puerta | La persona que registró los cambios. | La persona que registró los cambios. |
| En Git o TFVC mediante los desencadenadores programados | La identidad del sistema, por ejemplo: [DefaultCollection]\Project Collection Service Accounts |
La identidad del sistema, por ejemplo: [DefaultCollection]\Project Collection Service Accounts |
| Dado que ha hecho clic en el botón Queue build (Compilación de cola) | Usted | Usted |
Azure Pipelines | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2015
Nota:
En Microsoft Team Foundation Server (TFS) 2018 y versiones anteriores, las canalizaciones de compilación y versión se denominan definiciones, las ejecuciones se denominan compilaciones, las conexiones de servicio se denominan puntos de conexión de servicio, las fases se denominan entornos y los trabajos se denominan fases.
Las variables le dan una manera cómoda de obtener los bits clave de datos en varias partes de la canalización. Se trata de una lista de variables predefinidas que están disponibles para su uso. Puede haber algunas otras variables predefinidas, pero principalmente son para uso interno.
El sistema establece automáticamente estas variables y son de solo lectura. (Las excepciones son Build.Clean y System.Debug).
En las canalizaciones de YAML, puede hacer referencia a variables predefinidas como variables de entorno. Por ejemplo, la variable Build.ArtifactStagingDirectory se convierte en la variable BUILD_ARTIFACTSTAGINGDIRECTORY .
En el caso de las canalizaciones clásicas, puede usar variables de versión en las tareas de implementación para compartir la información común (por ejemplo, nombre del entorno, grupo de recursos, etc.).
Obtenga más información sobre cómo trabajar con variables.
Build.Clean
Se trata de una variable en desuso que modifica la forma en que el agente de compilación limpia el origen. Para obtener información sobre cómo limpiar el origen, consulte Limpieza del repositorio local en el agente.
Esta variable modifica cómo el agente de compilación limpia el origen. Para más información, consulte Limpieza del repositorio local en el agente.
System.AccessToken
System.AccessToken es una variable especial que lleva el token de seguridad utilizado por la compilación en ejecución.
En YAML, debe asignar explícitamente a System.AccessToken la canalización mediante una variable . Puede hacerlo en el nivel de paso o tarea:
steps:
- bash: echo This script could use $SYSTEM_ACCESSTOKEN
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
- powershell: |
Write-Host "This is a script that could use $env:SYSTEM_ACCESSTOKEN"
Write-Host "$env:SYSTEM_ACCESSTOKEN = $(System.AccessToken)"
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
Puede configurar el ámbito predeterminado para usar el System.AccessToken ámbito de autorización del trabajo de System.AccessToken.
System.Debug
Para obtener registros más detallados para depurar problemas de canalización, defina System.Debug y establezca en true .
Edite la canalización.
Seleccione Variables.
Agregue una nueva variable con el nombre
System.Debugy el valortrue.
Guarde la nueva variable.