FtpUpload@2 - FTP 上传 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.
# 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. 
    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 服务连接
stringcredsType = serviceEndpoint时是必需的。

指定 FTP 服务器的服务连接。 若要创建一个,请单击“管理”链接并创建新的通用服务连接,然后输入服务器 URL 的 FTP 服务器 URL,例如 ftp://server.example.com和所需的凭据。

如果目标服务器支持 FTPS,无论指定的协议(ftp://ftps://),都会始终建立安全连接。 若要仅允许安全连接,请使用 ftps:// 协议,例如 ftps://server.example.com。 如果指定了 ftps://,则与不支持 FTPS 的服务器的连接将失败。


serverUrl - 服务器 URL
stringcredsType = inputs时是必需的。

指定 FTP 服务器的 URL。


username - 用户名
stringcredsType = inputs时是必需的。

指定 FTP 连接的用户名。


password - 密码
stringcredsType = 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

信任具有 ftps://的 FTP 服务器的 SSL 证书,即使它是自签名证书,也不能由证书颁发机构(CA)验证。


customCmds - FTP 命令
string

连接时将发送到远程 FTP 服务器的可选 FTP 命令。


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性

输出变量

没有。

注解

使用此任务可以使用 FTP 将文件上传到远程计算机,或者通过 FTPS 安全地上传文件。

在哪里可以了解有关文件匹配模式的详细信息?

要求

要求 DESCRIPTION
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 此任务使用以下 命令限制运行: 受限
Settable 变量 此任务有权 设置以下变量:禁用设置变量
代理版本 2.182.1 或更高版本
任务类别 效用
要求 DESCRIPTION
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
Settable 变量 任意
代理版本 所有支持的代理版本。
任务类别 效用

另请参阅