DownloadPipelineArtifact@2: tarea Descargar artefactos de canalización v2
Use esta tarea para descargar artefactos de canalización de fases anteriores de esta canalización o de otra canalización.
Nota:
Para más información, incluidos los comandos de la CLI de Azure, consulte la descarga de artefactos.
Use esta tarea para descargar artefactos de canalización de fases anteriores de esta canalización o de otra canalización.
Importante
Esta tarea solo se admite en Azure DevOps Services. Si lo usa en Azure DevOps Server, recibirá un mensaje de error similar a Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
Usar descargar artefactos de compilación si usa Azure DevOps Server o TFS 2018.
Syntax
# Download Pipeline Artifacts v2
# Download build and pipeline artifacts.
- task: DownloadPipelineArtifact@2
inputs:
buildType: 'current' # 'current' | 'specific'. Alias: source. Required. Download artifacts produced by. Default: current.
#project: # string. Required when source == specific. Project.
#definition: # string. Alias: pipeline. Required when source == specific. Build pipeline.
#specificBuildWithTriggering: false # boolean. Alias: preferTriggeringPipeline. Optional. Use when source == specific. When appropriate, download artifacts from the triggering build. Default: false.
#buildVersionToDownload: 'latest' # 'latest' | 'latestFromBranch' | 'specific'. Alias: runVersion. Required when source == specific. Build version to download. Default: latest.
#branchName: 'refs/heads/master' # string. Alias: runBranch. Required when source == specific && runVersion == latestFromBranch. Branch name. Default: refs/heads/master.
#pipelineId: # string. Alias: runId | buildId. Required when source == specific && runVersion == specific. Build.
#tags: # string. Optional. Use when source == specific && runVersion != specific. Build Tags.
#allowPartiallySucceededBuilds: false # boolean. Optional. Use when source == specific && runVersion != specific. Download artifacts from partially succeeded builds. Default: false.
#allowFailedBuilds: false # boolean. Optional. Use when source == specific && runVersion != specific. Download artifacts from failed builds. Default: false.
#artifactName: # string. Alias: artifact. Artifact name.
#itemPattern: '**' # string. Alias: patterns. Matching patterns. Default: **.
targetPath: '$(Pipeline.Workspace)' # string. Alias: path | downloadPath. Required. Destination directory. Default: $(Pipeline.Workspace).
Entradas
buildType
- Descarga de artefactos generados por
Alias de entrada: source
. string
. Obligatorio. Valores permitidos: current
(ejecución actual), specific
(ejecución específica). Valor predeterminado: current
.
Descarga los artefactos generados por la ejecución de canalización actual o desde una ejecución de canalización específica.
project
- Proyecto
string
. Necesario cuando source == specific
.
Especifica el nombre del proyecto o el GUID desde el que se descargarán los artefactos de canalización.
definition
- Canalización de compilación
Alias de entrada: pipeline
. string
. Necesario cuando source == specific
.
Identificador de definición de la canalización. En una canalización definitionId
en ejecución, se puede encontrar en la variable System.DefinitionId . definitionId
También se puede recuperar de la dirección URL de la página de información general de la canalización en el portal de Azure DevOps. En el ejemplo de dirección URL siguiente, es definitionId
78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary
. Para descargar artefactos de una definición de canalización específica, capture el definitionId
elemento de esa canalización y especifíquelo como el pipeline
parámetro .
specificBuildWithTriggering
- Cuando corresponda, descargue artefactos de la compilación de desencadenamiento.
Alias de entrada: preferTriggeringPipeline
. boolean
. Opcional. Use cuando source == specific
. Valor predeterminado: false
.
Si está activada, la tarea descarga los artefactos de la compilación de desencadenamiento. Si no hay ninguna compilación de desencadenamiento desde la canalización especificada, la tarea descarga los artefactos de la compilación especificada en las opciones siguientes.
buildVersionToDownload
- Versión de compilación para descargar
Alias de entrada: runVersion
. string
. Necesario cuando source == specific
. Valores permitidos: latest
, latestFromBranch
(más reciente de una rama específica y las etiquetas de compilación especificadas), specific
(versión específica). Valor predeterminado: latest
.
Especifica la versión de compilación que se va a descargar.
branchName
- Nombre de rama
Alias de entrada: runBranch
. string
. Necesario cuando source == specific && runVersion == latestFromBranch
. Valor predeterminado: refs/heads/master
.
Especifica el filtro en el nombre de rama o referencia. Por ejemplo: refs/heads/develop
.
pipelineId
- Construir
Alias de entrada: runId | buildId
. string
. Necesario cuando source == specific && runVersion == specific
.
Identificador de la ejecución de canalización desde la que se descargarán los artefactos. En una canalización buildId
en ejecución, se puede encontrar en la variable Build.BuildId . buildId
También se puede recuperar de la dirección URL de la página de resumen de ejecución de canalización en el portal de Azure DevOps. En el ejemplo de dirección URL siguiente, es buildId
1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results
. Para descargar artefactos de una ejecución de canalización específica, capture el buildId
elemento de esa ejecución y especifíquelo como el buildId
parámetro .
tags
- Etiquetas de compilación
string
. Opcional. Use cuando source == specific && runVersion != specific
.
Lista delimitada por comas de etiquetas que la tarea usa para devolver compilaciones etiquetadas. No se devuelven compilaciones no etiquetadas.
allowPartiallySucceededBuilds
- Descargue artefactos de compilaciones parcialmente realizadas correctamente.
boolean
. Opcional. Use cuando source == specific && runVersion != specific
. Valor predeterminado: false
.
Especifica si la tarea de compilación descarga artefactos si la compilación se realiza correctamente o parcialmente.
allowFailedBuilds
- Descargue artefactos de compilaciones con errores.
boolean
. Opcional. Use cuando source == specific && runVersion != specific
. Valor predeterminado: false
.
Si está activada, la tarea de compilación descarga artefactos si la compilación se realiza correctamente o se produce un error.
artifactName
- Nombre del artefacto
Alias de entrada: artifact
. string
.
Especifica el nombre del artefacto que se va a descargar. Si el valor se deja vacío, la tarea descarga todos los artefactos asociados a la ejecución de la canalización.
itemPattern
- Patrones coincidentes
Alias de entrada: patterns
. string
. Valor predeterminado: **
.
Patrones de coincidencia de archivos que limitan los archivos descargados. El valor puede ser uno o varios patrones de coincidencia de archivos que son nuevas líneas delimitadas. Obtenga más información sobre los patrones de coincidencia de archivos.
targetPath
- Directorio de destino
Alias de entrada: path | downloadPath
. string
. Obligatorio. Valor predeterminado: $(Pipeline.Workspace)
.
Especifica una ruta de acceso relativa o absoluta en el equipo del agente donde se descargarán los artefactos. Si se aplica la opción de descarga múltiple (dejando un nombre de artefacto vacío), se creará un subdirectorio para cada descarga. Obtenga más información sobre artefactos en Azure Pipelines.
Opciones de control de tareas
Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.
Variables de salida
Esta tarea define las siguientes variables de salida, que puede consumir en pasos, trabajos y fases de bajada.
BuildNumber
Almacena el número de compilación del origen del artefacto de canalización.
Debido a la compatibilidad con versiones anteriores, esta variable devuelve BuildId.
Obtenga más información sobre las variables de compilación.
Esta tarea define las siguientes variables de salida, que puede consumir en pasos, trabajos y fases de bajada.
BuildNumber
Almacena el número de compilación del origen del artefacto de canalización.
Comentarios
Importante
Esta tarea solo se admite en Azure DevOps Services. Si lo usa en Azure DevOps Server, recibirá un mensaje de error similar a Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
Usar descargar artefactos de compilación si usa Azure DevOps Server o TFS 2018.
Use esta tarea para descargar artefactos de canalización de fases anteriores de esta canalización o de otra canalización. De forma predeterminada, los artefactos se descargan en $(Pipeline.Workspace)
. Si no especifica un nombre de artefacto, se creará un subdirectorio para cada artefacto descargado. Puede usar patrones de coincidencia de archivos para limitar los archivos que desea descargar.
Las palabras clave de publicación y descarga son métodos abreviados de tareas para publicar y descargar los artefactos de canalización.
¿Cómo puedo encontrar el id. de la canalización desde la que quiero descargar un artefacto?
Para buscar el definitionId de una definición de canalización específica
En una canalización en ejecución, definitionId
se puede encontrar en la variable System.DefinitionId . definitionId
También se puede recuperar de la dirección URL en la página de información general de la canalización en el portal de Azure DevOps. En el ejemplo de dirección URL siguiente, es definitionId
78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary
. Para descargar artefactos de una definición de canalización específica, capture el definitionId
de esa canalización y especifíquelo como parámetro pipeline
.
Para buscar el identificador de compilación de una ejecución de canalización específica
Identificador de la ejecución de la canalización desde la que se van a descargar los artefactos. En una canalización buildId
en ejecución, puede encontrarse en la variable Build.BuildId . buildId
También se puede recuperar de la dirección URL en la página de resumen de ejecución de canalización en el portal de Azure DevOps. En el ejemplo de dirección URL siguiente, buildId
es 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results
. Para descargar artefactos de una ejecución de canalización específica, capture el buildId
de esa ejecución y especifíquelo como parámetro buildId
.
Ejemplos
Descargar un artefacto específico
# Download an artifact named 'WebApp' to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
inputs:
artifactName: 'WebApp'
targetPath: $(Build.SourcesDirectory)/bin
Descargar artefactos desde un proyecto o canalización específico
# Download artifacts from a specific pipeline.
- task: DownloadPipelineArtifact@2
inputs:
buildType: 'specific'
project: 'FabrikamFiber'
definition: 12
buildVersionToDownload: 'latest'
Descargar de artefactos desde una rama específica
# Download artifacts from a specific branch with a tag
- task: DownloadPipelineArtifact@2
inputs:
buildType: 'specific'
project: 'FabrikamFiber'
definition: 12
buildVersionToDownload: 'latestFromBranch'
branchName: 'refs/heads/master'
tags: 'testTag'
Descargar un artefacto desde una ejecución de compilación específica
# Download an artifact named 'WebApp' from a specific build run to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
inputs:
buildType: 'specific'
artifactName: 'WebApp'
targetPath: $(Build.SourcesDirectory)/bin
project: 'FabrikamFiber'
definition: 12
buildVersionToDownload: 'specific'
pipelineId: 40
Requisitos
Requisito | Descripción |
---|---|
Tipos de canalización | YAML, compilación clásica, versión clásica |
Se ejecuta en | Agente, DeploymentGroup |
Peticiones | None |
Capabilities | Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo. |
Restricciones de comandos | Any |
Variables que se pueden establecer | Any |
Versión del agente | 2.164.1 o superior |
Categoría de la tarea: | Utilidad |