DownloadPipelineArtifact@1 - パイプライン成果物 v1 タスクをダウンロードする
このタスクを使用して、このパイプラインの以前のステージまたは別のパイプラインからパイプライン成果物をダウンロードします。
このタスクの新しいバージョンがあります。 詳細については、「 DownloadPipelineArtifact@2」を参照してください。
注意
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.
使用している場合は、「ビルド成果物のダウンロードを使用する」のようなエラー メッセージが表示されます。
構文
# Download Pipeline Artifacts v1
# Download a named artifact from a pipeline to a local path.
- task: DownloadPipelineArtifact@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.
#branchName: 'refs/heads/master' # string. Required when buildType == specific && buildVersionToDownload == latestFromBranch. Branch name. Default: refs/heads/master.
#pipelineId: # string. Alias: buildId. Required when buildType == specific && buildVersionToDownload == specific. Build.
#tags: # string. Optional. Use when buildType == specific && buildVersionToDownload != specific. Build Tags.
#artifactName: # string. Artifact name.
#itemPattern: '**' # string. Matching pattern. Default: **.
targetPath: '$(System.ArtifactsDirectory)' # string. Alias: downloadPath. Required. Destination directory. Default: $(System.ArtifactsDirectory).
# Download Pipeline Artifacts v1
# Download Pipeline Artifact.
- task: DownloadPipelineArtifact@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.
#branchName: 'refs/heads/master' # string. Required when buildType == specific && buildVersionToDownload == latestFromBranch. Branch name. Default: refs/heads/master.
#pipelineId: # string. Alias: buildId. Required when buildType == specific && buildVersionToDownload == specific. Build.
#tags: # string. Optional. Use when buildType == specific && buildVersionToDownload != specific. Build Tags.
#artifactName: # string. Artifact name.
#itemPattern: '**' # string. Matching pattern. Default: **.
targetPath: '$(System.ArtifactsDirectory)' # string. Alias: downloadPath. Required. Destination directory. Default: $(System.ArtifactsDirectory).
入力
buildType
-
によって生成された成果物をダウンロードする
string
. 必須です。 使用できる値: current
(現在のビルド)、 specific
(特定のビルド)。 既定値: current
。
現在のパイプライン実行または特定のパイプライン実行によって生成された成果物をダウンロードします。
project
-
プロジェクト
string
.
buildType == specific
の場合に必要です。
パイプライン成果物のダウンロード元となるプロジェクト名または GUID を指定します。
pipeline
-
ビルド パイプライン
入力エイリアス: definition
。
string
.
buildType == 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
-
必要に応じて、トリガーするビルドから成果物をダウンロードします。
boolean
. 省略可能。 の場合は buildType == specific
を使用します。 既定値: false
。
オンにすると、タスクはトリガーするビルドから成果物をダウンロードします。 指定したパイプラインからトリガービルドがない場合、タスクは以下のオプションで指定されたビルドから成果物をダウンロードします。
buildVersionToDownload
-
ダウンロードするビルド バージョン
string
.
buildType == specific
の場合に必要です。 使用できる値: latest
、 latestFromBranch
(特定のブランチと指定されたビルド タグからの最新) specific
、(特定のバージョン)。 既定値: latest
。
ダウンロードするビルド バージョンを指定します。
branchName
-
ブランチ名
string
.
buildType == specific && buildVersionToDownload == latestFromBranch
の場合に必要です。 既定値: refs/heads/master
。
ブランチ/ref 名のフィルターを指定します。 (例: refs/heads/develop
)。
pipelineId
-
ビルド
入力エイリアス: buildId
。
string
.
buildType == specific && buildVersionToDownload == 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
. 省略可能。 の場合は buildType == specific && buildVersionToDownload != specific
を使用します。
タグ付きビルドを返すためにタスクが使用するタグのコンマ区切りのリスト。 タグなしビルドは返されません。
artifactName
-
成果物名
string
.
ダウンロードする成果物の名前を指定します。 値が空のままの場合、タスクはパイプライン実行に関連付けられているすべての成果物をダウンロードします。
itemPattern
-
照合パターン
string
. 既定値: **
。
ダウンロードしたファイルを制限するファイル 一致パターン。 値には、改行で区切られた 1 つ以上のファイル 一致パターンを指定できます。 ファイル マッチング パターンの詳細を確認してください。
targetPath
-
宛先ディレクトリ
入力エイリアス: downloadPath
。
string
. 必須です。 既定値: $(System.ArtifactsDirectory)
。
成果物がダウンロードされるエージェント マシン上のパス。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
このタスクの新しいバージョンがあります。 詳細については、「 DownloadPipelineArtifact@2」を参照してください。
重要
このタスクは、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.
使用している場合は、「ビルド成果物のダウンロードを使用する」のようなエラー メッセージが表示されます。
既定では、成果物は $(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
指定します。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
上で実行 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.155.1 以降 |
タスクのカテゴリ | ユーティリティ |
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
上で実行 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.150.3 以降 |
タスクのカテゴリ | ユーティリティ |