Partilhar via


DownloadPipelineArtifact@2 - Download Pipeline Artifacts v2 tarefa

Use esta tarefa para baixar artefatos de pipeline de estágios anteriores desse pipeline ou de outro pipeline.

Observação

Para obter mais informações, incluindo comandos da CLI do Azure, consulte baixando artefatos.

Use esta tarefa para baixar artefatos de pipeline de estágios anteriores desse pipeline ou de outro pipeline.

Importante

Esta tarefa é suportada apenas nos Serviços de DevOps do Azure. Se você usá-lo no Servidor de DevOps do Azure, receberá uma mensagem de erro semelhante a Usar Baixar Artefatos de Compilação Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead. se estiver usando o Servidor de DevOps do Azure ou o TFS 2018.

Sintaxe

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

Insumos

buildType - Download de artefatos produzidos por
Alias de entrada: source. string. Obrigatório Valores permitidos: current (Execução atual), specific (Execução específica). Valor predefinido: current.

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


project - Projeto
string. Necessário quando source == specific.

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


definition - Construir pipeline
Alias de entrada: pipeline. string. Necessário quando source == specific.

O 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 parâmetro pipeline.


specificBuildWithTriggering - Quando apropriado, baixe artefatos da compilação de acionamento.
Alias de entrada: preferTriggeringPipeline. boolean. Opcional. Use quando source == specific. Valor predefinido: false.

Se estiver marcada, a tarefa baixará artefatos da compilação de acionamento. Se não houver nenhuma compilação de acionamento do pipeline especificado, a tarefa baixará artefatos da compilação especificada nas opções abaixo.


buildVersionToDownload - Versão de compilação para baixar
Alias de entrada: runVersion. string. Necessário quando source == specific. Valores permitidos: latest, latestFromBranch (Latest from specific branch and specified Build Tags), specific (Specific version). Valor predefinido: latest.

Especifica a versão de compilação a ser baixada.


branchName - Nome da filial
Alias de entrada: runBranch. string. Necessário quando source == specific && runVersion == latestFromBranch. Valor predefinido: refs/heads/master.

Especifica o filtro no nome da ramificação/ref. Por exemplo: refs/heads/develop.


pipelineId - Criar
Alias de entrada: runId | buildId. string. Necessário quando source == specific && runVersion == specific.

O identificador do pipeline é executado a partir 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 de 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 parâmetro buildId.


tags - Construir tags
string. Opcional. Use quando source == specific && runVersion != specific.

A lista delimitada por vírgulas de tags que a tarefa usa para retornar compilações marcadas. Compilações não marcadas não são retornadas.


allowPartiallySucceededBuilds - Baixe artefatos de compilações parcialmente bem-sucedidas.
boolean. Opcional. Use quando source == specific && runVersion != specific. Valor predefinido: false.

Especifica se os artefatos devem ser baixados de compilações parcialmente bem-sucedidas. Para fazer isso, você deve definir ambos e allowPartiallySucceededBuildsallowFailedBuilds para true.


allowFailedBuilds - Baixe artefatos de compilações com falha.
boolean. Opcional. Use quando source == specific && runVersion != specific. Valor predefinido: false.

Especifica se os artefatos devem ser baixados de compilações com falha.


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 de correspondência
Alias de entrada: patterns. string. Valor predefinido: **.

Os padrões de correspondência de arquivos que limitam os arquivos baixados. O valor pode ser um ou mais padrões de correspondência de arquivo que são delimitados por novas linhas. Saiba mais sobre padrões de correspondência de arquivos.

Ao contrário de outras tarefas, esta tarefa irá baixar um arquivo que corresponde a qualquer padrão. Excluir padrões não pode ser usado para excluir arquivos incluídos anteriormente e incluirá arquivos que não correspondem a nenhum padrão de inclusão.


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

Especifica um caminho relativo ou absoluto na máquina do agente onde 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 Artefatos no Azure Pipelines.


Opções de controlo de tarefas

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

Variáveis de saída

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

BuildNumber
Armazena o número de compilação da origem do artefato do pipeline.

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

Saiba mais sobre variáveis de compilação.

Observações

Importante

Esta tarefa é suportada apenas nos Serviços de DevOps do Azure. Se você usá-lo no Servidor de DevOps do Azure, receberá uma mensagem de erro semelhante a Usar Baixar Artefatos de Compilação Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead. se estiver usando o Servidor de DevOps do Azure ou o TFS 2018.

Use esta tarefa para baixar artefatos de pipeline de estágios anteriores desse pipeline ou de outro pipeline. Por padrão, os artefatos são baixados para $(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 publicar e baixar são atalhos de tarefas para publicar e baixar seus artefatos de pipeline.

Como posso encontrar o ID do Pipeline do qual quero baixar um artefato?

Para localizar o 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 parâmetro pipeline.

Para localizar o buildId para um pipeline específico, execute

O identificador do pipeline é executado a partir 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 de 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 parâmetro buildId.

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 uma ramificação 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'

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

Requerimentos

Requisito Descrição
Tipos de pipeline YAML, Construção clássica, Versão clássica
Funciona em Agente, DeploymentGroup
Exigências Nenhum
Capacidades Esta tarefa não satisfaz quaisquer exigências 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 de tarefa Utilidade