DownloadSecureFile@1 - セキュリティで保護されたファイル v1 タスクをダウンロードする

  • [アーティクル]

このタスクを使用して、セキュリティで保護されたファイルをエージェント コンピューターにダウンロードします。

このタスクを使用して、エージェント コンピューター上の一時的な場所にセキュリティで保護されたファイルをダウンロードします。

このタスクを使用して、ビルドまたはリリース エージェント上の一時的な場所にセキュリティで保護されたファイルをダウンロードします。

構文

# Download secure file v1
# Download a secure file to the agent machine.
- task: DownloadSecureFile@1
  inputs:
    secureFile: # string. Required. Secure File. 
    #retryCount: '8' # string. Retry Count. Default: 8.
    #socketTimeout: # string. Socket Timeout.

# Download secure file v1
# Download a secure file to the agent machine.
- task: DownloadSecureFile@1
  inputs:
    secureFile: # string. Required. Secure File. 
    #retryCount: '5' # string. Retry Count. Default: 5.

# Download secure file v1
# Download a secure file to a temporary location on the agent machine.
- task: DownloadSecureFile@1
  inputs:
    secureFile: # string. Required. Secure File.

# Download Secure File v1
# Download a secure file to a temporary location on the build or release agent.
- task: DownloadSecureFile@1
  inputs:
    secureFile: # string. Required. Secure File.

入力

secureFile - セキュリティで保護されたファイル
string. 必須です。

エージェント コンピューターにダウンロードされるセキュリティで保護されたファイルの名前または一意識別子 (GUID) を指定します。 パイプライン ジョブが完了すると、ファイルが削除されます。


retryCount - 再試行回数
string. 既定値: 8。

省略可能。 ダウンロードが失敗した場合にセキュリティで保護されたファイルのダウンロードを再試行する回数を指定します。


retryCount - 再試行回数
string. 既定値: 5。

任意。 ダウンロードが失敗した場合にセキュリティで保護されたファイルのダウンロードを再試行する回数を指定します。


socketTimeout - ソケットのタイムアウト
string.

省略可能。 Microsoft でセキュリティで保護されたファイル要求をダウンロードする場合、この入力はソケットのタイムアウトを指定します。


タスク コントロールのオプション

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

出力変数

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

secureFilePath
ダウンロードされたセキュリティで保護されたファイルの場所を指定します。

解説

パイプラインでこのタスクを使用して、 セキュリティで保護されたファイル をエージェント コンピューターにダウンロードします。 (入力を使用して secureFile ) ファイルの名前を指定する場合は、実際のファイル名ではなく、アップロード時に指定した名前を使用します。

ダウンロードしたら、タスクに設定されている値 (またはクラシック エディターの "参照名") を使用 name して、エージェント コンピューター上のセキュリティで保護されたファイルへのパスを参照します。 たとえば、タスクに という名前 mySecureFileが付けられた場合、そのパスは パイプラインで として $(mySecureFile.secureFilePath)参照できます。 または、ダウンロードしたセキュリティで保護されたファイルは、 によって $(Agent.TempDirectory)指定されたディレクトリにあります。 以下の完全な例を参照 してください。

パイプライン ジョブが完了すると、成功、失敗、または取り消されたかどうかに関係なく、セキュリティで保護されたファイルはダウンロード場所から削除されます。

このタスクは、セキュリティで保護されたファイルを (パイプライン ジョブの最後に) 自動的にダウンロード、インストール、および削除するため、 Apple 証明書 のインストールまたは Apple プロビジョニング プロファイル のインストール タスクでこのタスクを使用する必要があります。

このタスクは現在、インスタンスごとに 1 つのファイル タスクのみをサポートしています。

例

この例では、セキュリティで保護された証明書ファイルをダウンロードし、Linux 上の信頼された証明機関 (CA) ディレクトリにインストールします。

- task: DownloadSecureFile@1
  name: caCertificate
  displayName: 'Download CA certificate'
  inputs:
    secureFile: 'myCACertificate.pem'

- script: |
    echo Installing $(caCertificate.secureFilePath) to the trusted CA directory...
    sudo chown root:root $(caCertificate.secureFilePath)
    sudo chmod a+r $(caCertificate.secureFilePath)
    sudo ln -s $(caCertificate.secureFilePath) /etc/ssl/certs/

要件

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