このタスクを使用して、このパイプラインの前のステージまたは別のパイプラインからパイプライン成果物をダウンロードします。
注
Azure CLI コマンドを含む詳細については、成果物 のダウンロードに関するページを参照してください。
このタスクを使用して、このパイプラインの前のステージまたは別のパイプラインからパイプライン成果物をダウンロードします。
重要
このタスクは、Azure DevOps Services でのみサポートされています。 Azure DevOps Server で使用する場合は、Azure DevOps Server または TFS 2018 を使用している場合、Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
Build Artifacts のダウンロードを使用する場合と同様のエラー メッセージが表示されます。
構文
# 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).
入力
buildType
-
によって生成された成果物をダウンロードする
入力エイリアス: source
。
string
。 必須。 使用できる値: current
(現在の実行)、 specific
(特定の実行)。 既定値: current
。
現在のパイプライン実行または特定のパイプライン実行から生成された成果物をダウンロードします。
project
-
プロジェクト
string
。
source == specific
する場合に必要です。
パイプライン成果物のダウンロード元となるプロジェクト名または GUID を指定します。
ビルド パイプラインの definition
-
入力エイリアス: pipeline
。
string
。
source == specific
する場合に必要です。
パイプラインの定義 ID。 実行中のパイプラインでは、definitionId
は System.DefinitionId 変数にあります。
definitionId
は、Azure DevOps ポータルのパイプラインの概要ページの URL から取得することもできます。 次の URL の例では、definitionId
は 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary
です。 特定のパイプライン定義から成果物をダウンロードするには、そのパイプラインから definitionId
をキャプチャし、pipeline
パラメーターとして指定します。
specificBuildWithTriggering
-
必要に応じて、トリガーするビルドから成果物をダウンロードします。
入力エイリアス: preferTriggeringPipeline
。
boolean
。 任意。
source == specific
するときに使用します。 既定値: false
。
オンにすると、タスクはトリガー元のビルドから成果物をダウンロードします。 指定したパイプラインからビルドをトリガーしていない場合、タスクは次のオプションで指定されたビルドから成果物をダウンロードします。
をダウンロードするためのビルド バージョンの buildVersionToDownload
-
入力エイリアス: runVersion
。
string
。
source == specific
する場合に必要です。 使用できる値: latest
、latestFromBranch
(特定のブランチと指定したビルド タグからの最新)、specific
(特定のバージョン)。 既定値: latest
。
ダウンロードするビルド バージョンを指定します。
branchName
-
ブランチ名の
入力エイリアス: runBranch
。
string
。
source == specific && runVersion == latestFromBranch
する場合に必要です。 既定値: refs/heads/master
。
分岐/ref 名のフィルターを指定します。 たとえば、 refs/heads/develop
と指定します。
pipelineId
-
ビルド
入力エイリアス: runId | buildId
。
string
。
source == specific && runVersion == specific
する場合に必要です。
成果物のダウンロード元となるパイプライン実行の識別子。 実行中のパイプラインでは、buildId
は Build.BuildId 変数にあります。
buildId
は、Azure DevOps ポータルのパイプライン実行の概要ページの URL から取得することもできます。 次の URL の例では、buildId
は 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results
です。 特定のパイプライン実行から成果物をダウンロードするには、その実行から buildId
をキャプチャし、buildId
パラメーターとして指定します。
ビルド タグを tags
- する
string
。 任意。
source == specific && runVersion != specific
するときに使用します。
タグ付きビルドを返すためにタスクが使用するタグのコンマ区切りのリスト。 タグなしビルドは返されません。
allowPartiallySucceededBuilds
-
部分的に成功したビルドから成果物をダウンロードします。
boolean
。 任意。
source == specific && runVersion != specific
するときに使用します。 既定値: false
。
部分的に成功したビルドから成果物をダウンロードするかどうかを指定します。 そのためには、 allowPartiallySucceededBuilds
と allowFailedBuilds
の両方を true
に設定する必要があります。
allowFailedBuilds
-
失敗したビルドから成果物をダウンロードします。
boolean
。 任意。
source == specific && runVersion != specific
するときに使用します。 既定値: false
。
失敗したビルドから成果物をダウンロードするかどうかを指定します。
アーティファクト名を artifactName
- する
入力エイリアス: artifact
。
string
。
ダウンロードする成果物の名前を指定します。 値が空の場合、タスクはパイプライン実行に関連付けられているすべての成果物をダウンロードします。
itemPattern
-
パターンの照合
入力エイリアス: patterns
。
string
。 既定値: **
。
ダウンロードしたファイルを制限するファイル 一致パターン。 値には、改行で区切られた 1 つ以上のファイル 一致パターンを指定できます。 ファイル マッチング パターン の詳細を確認します。
他のタスクとは異なり、このタスクは任意のパターンに一致するファイルをダウンロードします。 除外パターンは、以前にインクルードされたファイルを除外するために使用することはできず、インクルード パターンに一致しないファイルが含まれます。
宛先ディレクトリ を
入力エイリアス: path | downloadPath
。
string
。 必須。 既定値: $(Pipeline.Workspace)
。
成果物をダウンロードするエージェント コンピューター上の相対パスまたは絶対パスを指定します。 マルチダウンロード オプションが適用されている場合 (空の成果物名を残すことによって)、ダウンロードごとにサブディレクトリが作成されます。 Azure Pipelines のアーティファクトの詳細を確認します。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール のオプションと一般的なタスクのプロパティ」を参照してください。
出力変数
このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。
BuildNumber
パイプライン成果物ソースのビルド番号を格納します。
下位互換性のため、この変数は BuildId を返します。
ビルド変数の詳細を確認します。
このタスクでは、次の 出力変数を定義します。この変数は、ダウンストリームのステップ、ジョブ、およびステージで使用できます。
BuildNumber
パイプライン成果物ソースのビルド番号を格納します。
注釈
重要
このタスクは、Azure DevOps Services でのみサポートされています。 Azure DevOps Server で使用する場合は、Azure DevOps Server または TFS 2018 を使用している場合、Pipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
Build Artifacts のダウンロードを使用する場合と同様のエラー メッセージが表示されます。
このタスクを使用して、このパイプラインの前のステージまたは別のパイプラインからパイプライン成果物をダウンロードします。 既定では、成果物は $(Pipeline.Workspace)
にダウンロードされます。 成果物名を指定しない場合は、ダウンロードされた成果物ごとにサブディレクトリが作成されます。
ファイル マッチング パターン を使用して、ダウンロードするファイルを制限できます。
発行キーワードとダウンロード キーワードは、パイプライン成果物を発行およびダウンロードするためのタスク ショートカットです。
成果物をダウンロードするパイプラインの ID を確認するにはどうすればよいですか?
特定のパイプライン定義の definitionId を検索するには
実行中のパイプラインでは、definitionId
は System.DefinitionId 変数にあります。
definitionId
は、Azure DevOps ポータルのパイプラインの概要ページの URL から取得することもできます。 次の URL の例では、definitionId
は 78: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build?definitionId=78&_a=summary
です。 特定のパイプライン定義から成果物をダウンロードするには、そのパイプラインから definitionId
をキャプチャし、pipeline
パラメーターとして指定します。
特定のパイプライン実行の buildId を検索するには
成果物のダウンロード元となるパイプライン実行の識別子。 実行中のパイプラインでは、buildId
は Build.BuildId 変数にあります。
buildId
は、Azure DevOps ポータルのパイプライン実行の概要ページの URL から取得することもできます。 次の URL の例では、buildId
は 1088: https://dev.azure.com/fabrikam-inc/FabrikamFiber/_build/results?buildId=1088&view=results
です。 特定のパイプライン実行から成果物をダウンロードするには、その実行から buildId
をキャプチャし、buildId
パラメーターとして指定します。
例示
特定の成果物をダウンロードする
# Download an artifact named 'WebApp' to 'bin' in $(Build.SourcesDirectory)
- task: DownloadPipelineArtifact@2
inputs:
artifactName: 'WebApp'
targetPath: $(Build.SourcesDirectory)/bin
特定のプロジェクト/パイプラインから成果物をダウンロードする
# Download artifacts from a specific pipeline.
- task: DownloadPipelineArtifact@2
inputs:
buildType: 'specific'
project: 'FabrikamFiber'
definition: 12
buildVersionToDownload: 'latest'
特定のブランチから成果物をダウンロードする
# 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'
特定のビルド実行から成果物をダウンロードする
# 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