Compartilhar via


FtpUpload@2 – Tarefa de carregamento de FTP v2

Use essa tarefa para carregar arquivos em um computador remoto usando FTP ou com segurança com FTPS.

Syntax

# 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.
# 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
    #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.

Entradas

credentialsOption - Método de autenticação
Alias de entrada: credsType. string. Obrigatórios. Valores permitidos: serviceEndpoint (conexão de serviço FTP), inputs (Inserir credenciais). Valor padrão: serviceEndpoint.

Especifica o método de autenticação. Use uma conexão de serviço FTP ou insira as credenciais de conexão.


serverEndpoint - Conexão de Serviço FTP
string. Obrigatório quando credsType = serviceEndpoint.

Especifica a conexão de serviço para o servidor FTP. Para criar uma, clique no link Gerenciar e crie uma nova conexão de serviço genérica e insira a URL do servidor FTP para a URL do servidor, por exemplo ftp://server.example.com, e as credenciais necessárias.

As conexões seguras sempre serão feitas independentemente do protocolo especificado (ftp:// ou ftps://) se o servidor de destino der suporte a FTPS. Para permitir apenas conexões seguras, use o ftps:// protocolo , por exemplo, ftps://server.example.com. As conexões com servidores que não dão suporte a FTPS falharão se ftps:// for especificado.


serverUrl - URL do servidor
string. Obrigatório quando credsType = inputs.

Especifica a URL do servidor FTP.


username - Username
string. Obrigatório quando credsType = inputs.

Especifica o nome de usuário para a conexão FTP.


password - Senha
string. Obrigatório quando credsType = inputs.

Especifica a senha para a conexão FTP.


implicitFTPS - Usar FTPS implícito
boolean. Valor padrão: false.


rootDirectory - Pasta raiz
Alias de entrada: rootFolder. string. Obrigatórios.

Especifica a pasta de origem da qual carregar arquivos.


filePatterns - Padrões de arquivo
string. Obrigatórios. Valor padrão: **.

Especifica os caminhos de arquivo ou padrões dos arquivos a serem carregados. A cadeia de caracteres dá suporte a várias linhas de padrões de minimatch. Saiba mais sobre padrões de correspondência de arquivos.


remoteDirectory - Diretório remoto
Alias de entrada: remotePath. string. Obrigatórios. Valor padrão: /upload/$(Build.BuildId)/.

Especifica o diretório no servidor FTP remoto em que a tarefa carrega arquivos.


enableUtf8 - Habilitar suporte a UTF8
boolean. Valor padrão: false.

Habilita o suporte a UTF-8 para a conexão FTP (OPTS UTF8 ON).


clean - Excluir diretório remoto
boolean. Valor padrão: false.

Exclui o diretório remoto, incluindo seu conteúdo, antes de carregar.


cleanContents - Limpar o conteúdo do diretório remoto
boolean. Opcional. Use quando clean = false. Valor padrão: false.

Exclui recursivamente todo o conteúdo no diretório remoto antes de carregar. O diretório existente não será excluído. Para melhorar o desempenho, use clean em vez disso.


preservePaths - Preservar caminhos de arquivo
boolean. Valor padrão: false.

Se selecionada, a estrutura de diretório local relativa será recriada no diretório remoto em que os arquivos são carregados. Caso contrário, os arquivos são carregados diretamente no diretório remoto sem criar subdiretórios adicionais.

Por exemplo, suponha que sua pasta de origem seja /home/user/source/, que contém o arquivo foo/bar/foobar.txte seu diretório remoto seja: /uploads/. Se esse booliano estiver selecionado, o arquivo será carregado em /uploads/foo/bar/foobar.txt. Se esse booliano não estiver selecionado, o arquivo será carregado em /uploads/foobar.txt.


trustSSL - Certificado do servidor de confiança
boolean. Valor padrão: false.

Confia no certificado SSL do servidor FTP com ftps://, mesmo que ele seja autoassinado ou não possa ser validado por uma AC (autoridade de certificação).


customCmds - Comandos FTP
string.

Os comandos FTP opcionais que serão enviados para o servidor FTP remoto após a conexão.


Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Use essa tarefa para carregar arquivos em um computador remoto usando FTP ou com segurança com FTPS.

Onde posso saber mais sobre padrões de correspondência de arquivos?

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando Essa tarefa é executada usando as seguintes restrições de comando: restrito
Variáveis configuráveis Essa tarefa tem permissão para definir as seguintes variáveis: A configuração de variáveis está desabilitada
Versão do agente 2.182.1 ou superior
Categoria da tarefa Utilitário
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
É executado em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente Todas as versões do agente com suporte.
Categoria da tarefa Utilitário

Confira também