DownloadPipelineArtifact@2 – Tarefa Baixar Artefatos de Pipeline v2

Use essa tarefa para baixar artefatos de pipeline de estágios anteriores neste pipeline ou de outro pipeline.

Observação

Para saber mais, incluindo comandos da CLI do Azure, confira Como baixar artefatos.

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 - Baixar artefatos produzidos por
Alias de entrada: source. string. Obrigatórios. Valores permitidos: current (execução atual), specific (execução específica). Valor padrão: current.

Baixa artefatos produzidos pela execução de pipeline atual ou de uma execução de pipeline específica.

project - Projeto
string. Obrigatório quando source == specific.

Especifica o nome do projeto ou GUID do qual baixar os artefatos de pipeline.

definition - Pipeline de build
Alias de entrada: pipeline. string. Obrigatório quando source == specific.

A ID de definição do pipeline. Em um pipeline em execução, o definitionId pode ser encontrado na variável System.DefinitionId . O definitionId também pode ser recuperado da URL na página de visão geral do pipeline no portal do Azure DevOps. No exemplo de URL a seguir, o definitionId é 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Para baixar artefatos de uma definição de pipeline específica, capture o definitionId desse pipeline e especifique-o como o pipeline parâmetro .

specificBuildWithTriggering - Quando apropriado, baixe artefatos do build de gatilho.
Alias de entrada: preferTriggeringPipeline. boolean. Opcional. Use quando source == specific. Valor padrão: false.

Se marcada, a tarefa baixa artefatos do build de gatilho. Se não houver nenhum build de gatilho do pipeline especificado, a tarefa baixará artefatos do build especificado nas opções abaixo.

buildVersionToDownload - Versão de build a ser baixada
Alias de entrada: runVersion. string. Obrigatório quando source == specific. Valores permitidos: latest, latestFromBranch (Mais recente do branch específico e marcas de build especificadas), specific (versão específica). Valor padrão: latest.

Especifica a versão de build a ser baixada.

branchName - Nome do branch
Alias de entrada: runBranch. string. Obrigatório quando source == specific && runVersion == latestFromBranch. Valor padrão: refs/heads/master.

Especifica o filtro no nome do branch/ref. Por exemplo: refs/heads/develop.

pipelineId - Construir
Alias de entrada: runId | buildId. string. Obrigatório quando source == specific && runVersion == specific.

O identificador da execução do pipeline do qual baixar os artefatos. Em um pipeline em execução, o buildId pode ser encontrado na variável Build.BuildId . O buildId também pode ser recuperado da URL na página de resumo da execução do pipeline no portal do Azure DevOps. No exemplo de URL a seguir, o buildId é 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Para baixar artefatos de uma execução de pipeline específica, capture o buildId dessa execução e especifique-o como o buildId parâmetro .

tags - Marcas de build
string. Opcional. Use quando source == specific && runVersion != specific.

A lista delimitada por vírgulas de marcas que a tarefa usa para retornar builds marcados. Builds não marcados não são retornados.

allowPartiallySucceededBuilds - Baixe artefatos de builds parcialmente bem-sucedidos.
boolean. Opcional. Use quando source == specific && runVersion != specific. Valor padrão: false.

Especifica se a tarefa de build baixa artefatos se o build é bem-sucedido ou parcialmente bem-sucedido.

allowFailedBuilds - Baixe artefatos de builds com falha.
boolean. Opcional. Use quando source == specific && runVersion != specific. Valor padrão: false.

Se marcada, a tarefa de build baixará artefatos se o build for bem-sucedido ou falhar.

artifactName - Nome do artefato
Alias de entrada: artifact. string.

Especifica o nome do artefato a ser baixado. Se o valor for deixado vazio, a tarefa baixará todos os artefatos associados à execução do pipeline.

itemPattern - Padrões correspondentes
Alias de entrada: patterns. string. Valor padrão: **.

Os padrões de correspondência de arquivo que limitam os arquivos baixados. O valor pode ser um ou mais padrões de correspondência de arquivo delimitados por uma nova linha. Saiba mais sobre padrões de correspondência de arquivos.

targetPath - Diretório de destino
Alias de entrada: path | downloadPath. string. Obrigatórios. Valor padrão: $(Pipeline.Workspace).

Especifica um caminho relativo ou absoluto no computador do agente em que os artefatos serão baixados. Se a opção de download múltiplo for aplicada (deixando um nome de artefato vazio), um subdiretório será criado para cada download. Saiba mais sobre o Artifacts no Azure Pipelines.

Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Essa tarefa define as variáveis de saída a seguir, que você pode consumir em etapas downstream, trabalhos e estágios.

BuildNumber
Armazena o número de build da origem do artefato do pipeline.

Devido à compatibilidade com versões anteriores, essa variável retorna BuildId.

Saiba mais sobre variáveis de build.

Comentários

Importante

Essa tarefa tem suporte apenas em Azure DevOps Services. Se você usá-lo em Azure DevOps Server, receberá uma mensagem de erro semelhante a Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead. Usar Baixar Artefatos de Build se estiver usando Azure DevOps Server ou TFS 2018.

Use essa tarefa para baixar artefatos de pipeline de estágios anteriores neste pipeline ou de outro pipeline. Por padrão, os artefatos são baixados em $(Pipeline.Workspace). Se você não especificar um nome de artefato, um subdiretório será criado para cada artefato baixado. Você pode usar padrões de correspondência de arquivos para limitar os arquivos que deseja baixar.

As palavras-chave de publicação e download são atalhos de tarefas para publicar e baixar seus artefatos de pipeline.

Como posso encontrar a ID do pipeline do qual quero baixar um artefato?

Para localizar a definitionId para uma definição de pipeline específica

Em um pipeline em execução, o definitionId pode ser encontrado na variável System.DefinitionId . O definitionId também pode ser recuperado da URL na página de visão geral do pipeline no portal do Azure DevOps. No exemplo de URL a seguir, o definitionId é 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary. Para baixar artefatos de uma definição de pipeline específica, capture o definitionId desse pipeline e especifique-o como o pipeline parâmetro .

Para localizar a buildId para uma execução de pipeline específica

O identificador da execução do pipeline do qual baixar os artefatos. Em um pipeline em execução, o buildId pode ser encontrado na variável Build.BuildId . O buildId também pode ser recuperado da URL na página de resumo da execução do pipeline no portal do Azure DevOps. No exemplo de URL a seguir, o buildId é 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results. Para baixar artefatos de uma execução de pipeline específica, capture o buildId dessa execução e especifique-o como o buildId parâmetro .

Exemplos

Baixar um artefato específico

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

Baixar artefatos de um projeto/pipeline específico

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

Baixar artefatos de um branch específico

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

Baixar um artefato de uma execução de compilação 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	Descrição
Tipos de pipeline	YAML, build clássico, versão clássica
Executa em	Agent, DeploymentGroup
Demandas	Nenhum
Funcionalidades	Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	2.164.1 ou superior
Categoria da tarefa	Utilitário