DownloadBuildArtifacts@1 - ビルド成果物 v1 タスクをダウンロードする

このタスクを使用して、完了したビルドの成果物として保存されたファイルをダウンロードします。

Azure DevOps Servicesを使用している場合は、パフォーマンスを向上させるために、パイプライン成果物のダウンロードとパイプライン成果物の発行を使用することをお勧めします。

構文

# Download build artifacts v1
# Download files that were saved as artifacts of a completed build.
- task: DownloadBuildArtifacts@1
  inputs:
    buildType: 'current' # 'current' | 'specific'. Required. Download artifacts produced by. Default: current.
    #project: # string. Required when buildType == specific. Project. 
    #pipeline: # string. Alias: definition. Required when buildType == specific. Build pipeline. 
    #specificBuildWithTriggering: false # boolean. Optional. Use when buildType == specific. When appropriate, download artifacts from the triggering build. Default: false.
    #buildVersionToDownload: 'latest' # 'latest' | 'latestFromBranch' | 'specific'. Required when buildType == specific. Build version to download. Default: latest.
    #allowPartiallySucceededBuilds: false # boolean. Optional. Use when buildType == specific && buildVersionToDownload != specific. Download artifacts even from partially succeeded builds. Default: false.
    #branchName: 'refs/heads/master' # string. Required when buildType == specific && buildVersionToDownload == latestFromBranch. Branch name. Default: refs/heads/master.
    #buildId: # string. Required when buildType == specific && buildVersionToDownload == specific. Build. 
    #tags: # string. Optional. Use when buildType == specific && buildVersionToDownload != specific. Build Tags. 
    downloadType: 'single' # 'single' | 'specific'. Required. Download type. Default: single.
    artifactName: # string. Required when downloadType == single. Artifact name. 
    #itemPattern: '**' # string. Matching pattern. Default: **.
    downloadPath: '$(System.ArtifactsDirectory)' # string. Required. Destination directory. Default: $(System.ArtifactsDirectory).
    #cleanDestinationFolder: false # boolean. Clean destination folder. Default: false.
  # Advanced
    #parallelizationLimit: '8' # string. Parallelization limit. Default: 8.
    #checkDownloadedFiles: false # boolean. Check downloaded files. Default: false.
    #retryDownloadCount: '4' # string. Retry count. Default: 4.
    #extractTars: # boolean. Extract all files that are stored inside tar archives.

入力

buildType - によって生成された成果物をダウンロードする
string. 必須です。 使用できる値: current (現在のビルド)、 specific (特定のビルド)。 既定値: current。

現在のビルドによって生成された成果物をダウンロードするか、特定のビルドからダウンロードするか。

project - プロジェクト
string. buildType == specific の場合に必要です。

ビルド成果物のダウンロード元となるプロジェクト。

pipeline - ビルド パイプライン
入力エイリアス: definition。 string. buildType == specific の場合に必要です。

ビルド パイプライン名を指定します。

specificBuildWithTriggering - 必要に応じて、トリガーするビルドから成果物をダウンロードします。
boolean. 省略可能。 の場合は buildType == specificを使用します。 既定値: false。

の場合 true、このビルド タスクは、トリガーするビルドから成果物のダウンロードを試みます。 指定したパイプラインからのトリガー ビルドがない場合は、次のオプションで指定されたビルドから成果物をダウンロードします。

buildVersionToDownload - ダウンロードするビルド バージョン
string. buildType == specific の場合に必要です。 使用できる値: latest、 latestFromBranch (特定のブランチと指定されたビルド タグからの最新) specific 、(特定のバージョン)。 既定値: latest。

ダウンロードするビルドのバージョンを指定します。

• 利用可能な最新のビルド バージョンをダウンロードすることを選択 latest します。
• で指定されたブランチと でbranchName指定されたタグの利用可能な最新のビルド バージョンをtagsダウンロードすることを選択latestFromBranchします。
• で指定されたビルド バージョンをダウンロードすることをbuildId選択specificします。

allowPartiallySucceededBuilds - 部分的に成功したビルドからでも成果物をダウンロードします。
boolean. 省略可能。 の場合は buildType == specific && buildVersionToDownload != specificを使用します。 既定値: false。

の場合 true、このビルド タスクは、ビルドが成功したか部分的に成功したかに関係なく、成果物のダウンロードを試みます。

branchName - ブランチ名
string. buildType == specific && buildVersionToDownload == latestFromBranch の場合に必要です。 既定値: refs/heads/master。

ブランチ/ref 名でフィルター処理するかどうかを指定します (例: refs/heads/develop)。

buildId - ビルド
string. buildType == specific && buildVersionToDownload == specific の場合に必要です。

成果物をダウンロードするビルド。

tags - ビルド タグ
string. 省略可能。 の場合は buildType == specific && buildVersionToDownload != specificを使用します。

タグのコンマ区切りのリスト。 これらのタグを持つビルドのみが返されます。

downloadType - ダウンロードの種類
string. 必須です。 使用できる値: single (特定の成果物)、 specific (特定のファイル)。 既定値: single。

ビルドから特定の成果物または特定のファイルをダウンロードします。

• で指定された特定の成果物を 1 つだけ必要とする場合は、(特定の成果物) を選択 single します artifactName
• 選択 specific したビルドのすべての成果物が必要な場合は、(特定のファイル) を選択します

artifactName - 成果物名
string. downloadType == single の場合に必要です。

ダウンロードする成果物の名前。

itemPattern - 一致パターン
string. 既定値: **。

複数行のミニマッチ パターンとしてダウンロードするファイルを指定します。 詳細については、「 ファイルマッチングパターンリファレンス」を参照してください。

既定のパターン \*\* では、[特定のファイル] オプションを選択すると、ビルド内のすべての成果物のすべての ファイル がダウンロードされます。 成果物ドロップ内のすべてのファイルをダウンロードするには、 を使用 drop/**します。

downloadPath - 宛先ディレクトリ
string. 必須です。 既定値: $(System.ArtifactsDirectory)。

成果物がダウンロードされるエージェント コンピューター上のパス。

cleanDestinationFolder - コピー先フォルダーをクリーンアップする
boolean. 既定値: false。

成果物のダウンロード前に、コピー先フォルダー内のすべての既存のファイルを削除します。

parallelizationLimit - 並列化の制限
string. 既定値: 8。

同時にダウンロードするファイルの数。

checkDownloadedFiles - ダウンロードしたファイルを確認する
boolean. 既定値: false。

の場合 true、このビルド タスクは、すべてのファイルが完全にダウンロードされていることを確認します。

retryDownloadCount - 再試行回数
string. 既定値: 4。

ダウンロードが失敗した場合にビルド成果物のダウンロードを再試行する回数。

extractTars - tar アーカイブ内に格納されているすべてのファイルを抽出する
boolean.

に true 設定すると、 .tar 拡張子を持つダウンロードしたすべてのファイルが抽出されます。 これは、Unix ファイルのアクセス許可を保持する場合は、成果物ファイルを tar にパックする必要があるために役立ちます。 [ビルド 成果物のStoreAsTar発行] タスクで オプションを有効にすると、成果物が .tar ファイルとして自動的に格納されます。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

このタスクでは、ダウンストリームのステップ、ジョブ、およびステージで使用できる次の 出力変数を定義します。

BuildNumber
ビルド成果物ソースのビルド番号を格納します。

この入力では、下位互換性のため BuildId が 返されることに注意してください。 詳細については、「 変数」を参照してください。

注釈

注意

Azure Pipelines チームは、パフォーマンスを向上させるために 、ビルド成果物 から パイプライン成果物 にアップグレードすることをお勧めします。

要件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
上で実行	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	2.191.1 以降
タスクのカテゴリ	ユーティリティ