DownloadPipelineArtifact@2 - Tâche Télécharger les artefacts de pipeline v2

Utilisez cette tâche pour télécharger des artefacts de pipeline à partir des étapes antérieures de ce pipeline ou d’un autre pipeline.

Notes

Pour plus d’informations, notamment les commandes Azure CLI, consultez téléchargement d’artefacts.

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

Entrées

buildType - Télécharger les artefacts produits par
Alias d’entrée : source. string. Obligatoire. Valeurs autorisées : current (Exécution actuelle), specific (Exécution spécifique). Valeur par défaut : current.

Télécharge les artefacts produits par l’exécution du pipeline en cours ou à partir d’une exécution de pipeline spécifique.

project - Projet
string. Nécessaire lorsque source == specific.

Spécifie le nom du projet ou le GUID à partir duquel télécharger les artefacts de pipeline.

definition - Pipeline de build
Alias d’entrée : pipeline. string. Nécessaire lorsque source == specific.

ID de définition du pipeline. Dans un pipeline en cours d’exécution, le definitionId se trouve dans la variable System.DefinitionId . Peut definitionId également être récupéré à partir de l’URL de la page de vue d’ensemble du pipeline dans le portail Azure DevOps. Dans l’exemple d’URL suivant, est definitionId 78 : https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Pour télécharger des artefacts à partir d’une définition de pipeline spécifique, capturez le definitionId à partir de ce pipeline et spécifiez-le pipeline en tant que paramètre.

specificBuildWithTriggering - Le cas échéant, téléchargez les artefacts à partir de la build de déclenchement.
Alias d’entrée : preferTriggeringPipeline. boolean. facultatif. Utilisez quand source == specific. Valeur par défaut : false.

Si cette option est cochée, la tâche télécharge les artefacts à partir de la build de déclenchement. Si aucune build n’est déclenchée à partir du pipeline spécifié, la tâche télécharge les artefacts à partir de la build spécifiée dans les options ci-dessous.

buildVersionToDownload - Version de build à télécharger
Alias d’entrée : runVersion. string. Nécessaire lorsque source == specific. Valeurs autorisées : latest, latestFromBranch (Dernière version de la branche spécifique et balises de build spécifiées), specific (version spécifique). Valeur par défaut : latest.

Spécifie la version de build à télécharger.

branchName - Nom de la branche
Alias d’entrée : runBranch. string. Nécessaire lorsque source == specific && runVersion == latestFromBranch. Valeur par défaut : refs/heads/master.

Spécifie le filtre sur le nom de branche/ref. Par exemple : refs/heads/develop.

pipelineId - Construire
Alias d’entrée : runId | buildId. string. Nécessaire lorsque source == specific && runVersion == specific.

Identificateur de l’exécution du pipeline à partir duquel télécharger les artefacts. Dans un pipeline en cours d’exécution, le buildId se trouve dans la variable Build.BuildId . Peut buildId également être récupéré à partir de l’URL de la page de résumé de l’exécution du pipeline dans le portail Azure DevOps. Dans l’exemple d’URL suivant, est buildId 1088 : https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Pour télécharger des artefacts à partir d’une exécution de pipeline spécifique, capturez le buildId à partir de cette exécution et spécifiez-le buildId en tant que paramètre.

tags - Balises de build
string. facultatif. Utilisez quand source == specific && runVersion != specific.

Liste délimitée par des virgules des balises que la tâche utilise pour retourner des builds balisées. Les builds non marquées ne sont pas retournées.

allowPartiallySucceededBuilds - Téléchargez des artefacts à partir de builds partiellement réussies.
boolean. facultatif. Utilisez quand source == specific && runVersion != specific. Valeur par défaut : false.

Spécifie si la tâche de génération télécharge des artefacts si la build réussit ou réussit partiellement.

allowFailedBuilds - Téléchargez des artefacts à partir de builds ayant échoué.
boolean. facultatif. Utilisez quand source == specific && runVersion != specific. Valeur par défaut : false.

Si cette option est cochée, la tâche de génération télécharge des artefacts, que la build réussisse ou échoue.

artifactName - Nom de l’artefact
Alias d’entrée : artifact. string.

Spécifie le nom de l’artefact à télécharger. Si la valeur est laissée vide, la tâche télécharge tous les artefacts associés à l’exécution du pipeline.

itemPattern - Modèles de correspondance
Alias d’entrée : patterns. string. Valeur par défaut : **.

Modèles de correspondance de fichiers qui limitent les fichiers téléchargés. La valeur peut être un ou plusieurs modèles de correspondance de fichier délimités par une nouvelle ligne. En savoir plus sur les modèles de correspondance de fichiers.

targetPath - Répertoire de destination
Alias d’entrée : path | downloadPath. string. Obligatoire. Valeur par défaut : $(Pipeline.Workspace).

Spécifie un chemin d’accès relatif ou absolu sur l’ordinateur de l’agent où les artefacts seront téléchargés. Si l’option de téléchargement multiple est appliquée (en laissant un nom d’artefact vide), un sous-répertoire est créé pour chaque téléchargement. En savoir plus sur les artefacts dans Azure Pipelines.

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Cette tâche définit les variables de sortie suivantes, que vous pouvez utiliser dans les étapes, les travaux et les étapes en aval.

BuildNumber
Stocke le numéro de build de la source de l’artefact de pipeline.

En raison de la compatibilité descendante, cette variable retourne BuildId.

En savoir plus sur les variables de build.

Remarques

Important

Cette tâche est prise en charge sur Azure DevOps Services uniquement. Si vous l’utilisez sur Azure DevOps Server, vous recevrez un message d’erreur similaire à Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead. Utiliser télécharger des artefacts de build si vous utilisez Azure DevOps Server ou TFS 2018.

Utilisez cette tâche pour télécharger des artefacts de pipeline à partir des étapes antérieures de ce pipeline ou d’un autre pipeline. Par défaut, les artefacts sont téléchargés dans $(Pipeline.Workspace). Si vous ne spécifiez pas de nom d’artefact, un sous-répertoire est créé pour chaque artefact téléchargé. Vous pouvez utiliser des modèles de correspondance de fichiers pour limiter les fichiers que vous souhaitez télécharger.

Les mots clés de publication et de téléchargement sont des raccourcis de tâches permettant de publier et de télécharger vos artefacts de pipeline.

Comment trouver l’ID du pipeline à partir duquel je souhaite télécharger un artefact ?

Pour rechercher l’id de définition d’une définition de pipeline spécifique

Dans un pipeline en cours d’exécution, le definitionId se trouve dans la variable System.DefinitionId . Peut definitionId également être récupéré à partir de l’URL de la page de vue d’ensemble du pipeline dans le portail Azure DevOps. Dans l’exemple d’URL suivant, est definitionId 78 : https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Pour télécharger des artefacts à partir d’une définition de pipeline spécifique, capturez le definitionId à partir de ce pipeline et spécifiez-le pipeline en tant que paramètre.

Pour rechercher le buildId d’une exécution de pipeline spécifique

Identificateur de l’exécution du pipeline à partir duquel télécharger les artefacts. Dans un pipeline en cours d’exécution, le buildId se trouve dans la variable Build.BuildId . Peut buildId également être récupéré à partir de l’URL de la page de résumé de l’exécution du pipeline dans le portail Azure DevOps. Dans l’exemple d’URL suivant, est buildId 1088 : https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Pour télécharger des artefacts à partir d’une exécution de pipeline spécifique, capturez le buildId à partir de cette exécution et spécifiez-le buildId en tant que paramètre.

Exemples

Télécharger un artefact spécifique

# Download an artifact named 'WebApp' to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
  inputs:
    artifactName: 'WebApp'
    targetPath: $(Build.SourcesDirectory)/bin

Télécharger des artefacts à partir d’un projet/pipeline spécifique

# Download artifacts from a specific pipeline.
- task: DownloadPipelineArtifact@2
  inputs:
    buildType: 'specific'
    project: 'FabrikamFiber'
    definition: 12
    buildVersionToDownload: 'latest'

Télécharger des artefacts à partir d’une branche spécifique

# 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'

Télécharger un artefact à partir d’une exécution de build spécifique

# 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

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique, version classique
S’exécute sur	Agent, DeploymentGroup
Demandes	None
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande	Quelconque
Variables paramétrables	Quelconque
Version de l’agent	2.164.1 ou version ultérieure
Catégorie de la tâche	Utilitaire