Skip to content

Latest commit

 

History

History
275 lines (216 loc) · 10.4 KB

curl-uploader-v2.md

File metadata and controls

275 lines (216 loc) · 10.4 KB
Raw
title description ms.date monikerRange
cURLUploader@2 - cURL Upload Files v2 task
Use cURL's supported protocols to upload files.
07/02/2024
<=azure-pipelines

cURLUploader@2 - cURL Upload Files v2 task

:::moniker range=">=azure-pipelines-2019.1"

Use this task with cURL to upload files. Supported data transfer protocols include FTP, FTPS, SFTP, HTTP, and others.

:::moniker-end

:::moniker range="=azure-pipelines-2019"

Use cURL to upload files.

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2019.1"

# cURL Upload Files v2
# Use cURL's supported protocols to upload files.
- task: cURLUploader@2
  inputs:
    files: # string. Required. Files. 
    #authType: 'ServiceEndpoint' # 'ServiceEndpoint' | 'UserAndPass'. Authentication Method. Default: ServiceEndpoint.
    serviceEndpoint: # string. Required when authType = ServiceEndpoint. Service Connection. 
    #username: # string. Optional. Use when authType = UserAndPass. Username. 
    #password: # string. Optional. Use when authType = UserAndPass. Password. 
    #url: # string. Required when authType = UserAndPass. URL. 
    #remotePath: 'upload/$(Build.BuildId)/' # string. Remote Directory. Default: upload/$(Build.BuildId)/.
    #options: # string. Optional Arguments. 
  # Advanced
    #redirectStderr: true # boolean. Redirect Standard Error to Standard Out. Default: true.

:::moniker-end

:::moniker range="=azure-pipelines-2019"

# cURL Upload Files v2
# Use cURL to upload files.
- task: cURLUploader@2
  inputs:
    files: # string. Required. Files. 
    #authType: 'ServiceEndpoint' # 'ServiceEndpoint' | 'UserAndPass'. Authentication Method. Default: ServiceEndpoint.
    serviceEndpoint: # string. Required when authType = ServiceEndpoint. Service Connection. 
    #username: # string. Optional. Use when authType = UserAndPass. Username. 
    #password: # string. Optional. Use when authType = UserAndPass. Password. 
    #url: # string. Required when authType = UserAndPass. URL. 
    #remotePath: 'upload/$(Build.BuildId)/' # string. Remote Directory. Default: upload/$(Build.BuildId)/.
    #options: # string. Optional Arguments. 
  # Advanced
    #redirectStderr: true # boolean. Redirect Standard Error to Standard Out. Default: true.

:::moniker-end

Inputs

:::moniker range="<=azure-pipelines"

files - Files
string. Required.

File(s) to be uploaded. Wildcards can be used. For example, **/*.zip for all ZIP files in all subfolders.


:::moniker-end

:::moniker range=">=azure-pipelines-2019"

authType - Authentication Method
string. Allowed values: ServiceEndpoint (Service connection), UserAndPass (Username and password). Default value: ServiceEndpoint.

Specifies the authentication method for server authentication.


:::moniker-end

:::moniker range=">=azure-pipelines-2019"

serviceEndpoint - Service Connection
string. Required when authType = ServiceEndpoint.

Specifies the service connection with the credentials for the server authentication. Use the Generic service connection type for the service connection.


:::moniker-end

:::moniker range="<=azure-pipelines"

username - Username
string. Optional. Use when authType = UserAndPass.

Specifies the username for server authentication.


:::moniker-end

:::moniker range="<=azure-pipelines"

password - Password
string. Optional. Use when authType = UserAndPass.

Specifies the password for server authentication. Use a new build variable with its lock enabled on the Variables tab to encrypt this value. Use a secret variable to avoid exposing ths value.


:::moniker-end

:::moniker range="<=azure-pipelines"

url - URL
string. Required when authType = UserAndPass.

Specifies the URL to where the file(s) will be uploaded. The directory should end with a trailing slash. Possible URL protocols include DICT://, FILE://, FTP://, FTPS://, GOPHER://, HTTP://, HTTPS://, IMAP://, IMAPS://, LDAP://, LDAPS://, POP3://, POP3S://, RTMP://, RTSP://, SCP://, SFTP://, SMTP://, SMTPS://, TELNET:// and TFTP://.


:::moniker-end

:::moniker range=">=azure-pipelines-2019"

remotePath - Remote Directory
string. Default value: upload/$(Build.BuildId)/.

Optional. Specifies the sub-folder on the remote server for the URL supplied in the credentials.


:::moniker-end

:::moniker range="<=azure-pipelines"

options - Optional Arguments
string.

Optional. The additional arguments that will be passed to cURL.


:::moniker-end

:::moniker range="<=azure-pipelines"

redirectStderr - Redirect Standard Error to Standard Out
boolean. Default value: true.

Adds --stderr - as an argument to cURL. By default, cURL writes its progress bar to stderr, which is interpreted by the build as error output. Enabling this checkbox suppresses that behavior.


:::moniker-end

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

:::moniker range="<=azure-pipelines"

None.

:::moniker-end

Remarks

Use this task to use cURL to upload files with supported protocols such as FTP, FTPS, SFTP, HTTP, and more.

[!INCLUDE include]

Where can I learn FTP commands?

Requirements

:::moniker range=">=azure-pipelines-2022"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions This task runs using the following command restrictions: restricted
Settable variables This task has permission to set the following variables: Setting variables is disabled
Agent version 2.182.1 or greater
Task category Utility

:::moniker-end

:::moniker range=">=azure-pipelines-2019.1 <=azure-pipelines-2020.1"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version All supported agent versions.
Task category Utility

:::moniker-end

:::moniker range="=azure-pipelines-2019"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands Self-hosted agents must have capabilities that match the following demands to run jobs that use this task: curl
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version All supported agent versions.
Task category Utility

:::moniker-end