FtpUpload@2 - FTP upload v2 タスク

このタスクを使用して、FTP を使用してリモート コンピューターにファイルをアップロードするか、FTPS で安全にファイルをアップロードします。

構文

# FTP upload v2
# Upload files using FTP.
- task: FtpUpload@2
  inputs:
    credentialsOption: 'serviceEndpoint' # 'serviceEndpoint' | 'inputs'. Alias: credsType. Required. Authentication Method. Default: serviceEndpoint.
    serverEndpoint: # string. Required when credsType = serviceEndpoint. FTP Service Connection. 
    #serverUrl: # string. Required when credsType = inputs. Server URL. 
    #username: # string. Required when credsType = inputs. Username. 
    #password: # string. Required when credsType = inputs. Password. 
    #implicitFTPS: false # boolean. Use implicit FTPS. Default: false.
    rootDirectory: # string. Alias: rootFolder. Required. Root folder. 
    filePatterns: '**' # string. Required. File patterns. Default: **.
    remoteDirectory: '/upload/$(Build.BuildId)/' # string. Alias: remotePath. Required. Remote directory. Default: /upload/$(Build.BuildId)/.
  # Advanced
    #enableUtf8: false # boolean. Enable UTF8 support. Default: false.
    #clean: false # boolean. Delete remote directory. Default: false.
    #cleanContents: false # boolean. Optional. Use when clean = false. Clear remote directory contents. Default: false.
    #preservePaths: false # boolean. Preserve file paths. Default: false.
    #trustSSL: false # boolean. Trust server certificate. Default: false.
    #customCmds: # string. FTP Commands.

入力

credentialsOption - 認証方法
入力エイリアス: credsType。 string. 必須です。 使用できる値: serviceEndpoint (FTP サービス接続) inputs 、(資格情報の入力)。 既定値: serviceEndpoint。

認証方法を指定します。 FTP サービス接続を使用するか、接続資格情報を入力します。

serverEndpoint - FTP サービス接続
string. credsType = serviceEndpoint の場合に必要です。

FTP サーバーのサービス接続を指定します。 作成するには、[管理] リンクをクリックして新しい汎用サービス接続を作成し、サーバー URL の FTP サーバー URL (例: ftp://server.example.com) と必要な資格情報を入力します。

ターゲット サーバーが FTPS をサポートしている場合、指定されたプロトコル (ftp:// または ftps://) に関係なく、セキュリティで保護された接続が常に行われます。 セキュリティで保護された接続のみを許可するには、プロトコル (例: ) をftps://使用します。 ftps://server.example.com が指定されている場合 ftps:// 、FTPS をサポートしていないサーバーへの接続は失敗します。

serverUrl - サーバー URL
string. credsType = inputs の場合に必要です。

FTP サーバーの URL を指定します。

username - 名
string. credsType = inputs の場合に必要です。

FTP 接続のユーザー名を指定します。

password - パスワード
string. credsType = inputs の場合に必要です。

FTP 接続のパスワードを指定します。

implicitFTPS - 暗黙的な FTPS を使用する
boolean. 既定値: false。

rootDirectory - ルート フォルダー
入力エイリアス: rootFolder。 string. 必須です。

ファイルのアップロード元のソース フォルダーを指定します。

filePatterns - ファイル パターン
string. 必須です。 既定値: **。

アップロードするファイルのファイル パスまたはパターンを指定します。 文字列は、複数行のミニマッチ パターンをサポートしています。 ファイル マッチング パターンの詳細を確認してください。

remoteDirectory - リモート ディレクトリ
入力エイリアス: remotePath。 string. 必須です。 既定値: /upload/$(Build.BuildId)/。

タスクがファイルをアップロードするリモート FTP サーバー上のディレクトリを指定します。

enableUtf8 - UTF8 サポートを有効にする
boolean. 既定値: false。

FTP 接続の UTF-8 サポートを有効にします (OPTS UTF8 ON)。

clean - リモート ディレクトリを削除する
boolean. 既定値: false。

アップロードする前に、その内容を含むリモート ディレクトリを削除します。

cleanContents - リモート ディレクトリの内容をクリアする
boolean. 省略可能。 の場合は clean = falseを使用します。 既定値: false。

アップロードする前に、リモート ディレクトリ内のすべてのコンテンツを再帰的に削除します。 既存のディレクトリは削除されません。 パフォーマンスを向上させるには、代わりに を使用 clean してください。

preservePaths - ファイル パスを保持する
boolean. 既定値: false。

選択すると、ファイルがアップロードされるリモート ディレクトリの下に相対ローカル ディレクトリ構造が再作成されます。 それ以外の場合、ファイルは追加のサブディレクトリを作成せずにリモート ディレクトリに直接アップロードされます。

たとえば、ソース フォルダーが /home/user/source/で、ファイル foo/bar/foobar.txtが含まれており、リモート ディレクトリが であるとします /uploads/。 このブール値が選択されている場合、ファイルは に /uploads/foo/bar/foobar.txtアップロードされます。 このブール値が選択されていない場合、ファイルは に /uploads/foobar.txtアップロードされます。

trustSSL - サーバー証明書を信頼する
boolean. 既定値: false。

FTP サーバーの SSL 証明書 ftps://が自己署名されているか、証明機関 (CA) によって検証できない場合でも、 を使用して信頼します。

customCmds - FTP コマンド
string.

接続時にリモート FTP サーバーに送信されるオプションの FTP コマンド。

タスク制御オプション

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

出力変数

[なし] :

解説

このタスクを使用して、FTP を使用してリモート コンピューターにファイルをアップロードするか、FTPS で安全にファイルをアップロードします。

ファイル一致パターンの詳細はどこで確認できますか?

• ファイル一致パターンのリファレンス

要件

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

こちらもご覧ください

• ファイル一致パターンのリファレンス