Partage via


FtpUpload@2 - Tâche de chargement FTP v2

Utilisez cette tâche pour charger des fichiers sur un ordinateur distant à l’aide de FTP ou de manière sécurisée avec 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.

Entrées

credentialsOption - Méthode d’authentification
Alias d’entrée : credsType. string. Obligatoire. Valeurs autorisées : serviceEndpoint (connexion de service FTP), inputs (Entrez les informations d’identification). Valeur par défaut : serviceEndpoint.

Spécifie la méthode d’authentification. Utilisez une connexion de service FTP ou entrez les informations d’identification de connexion.


serverEndpoint - Connexion au service FTP
string. Nécessaire lorsque credsType = serviceEndpoint.

Spécifie la connexion de service pour le serveur FTP. Pour en créer une, cliquez sur le lien Gérer et créez une nouvelle connexion de service générique, puis entrez l’URL du serveur FTP pour l’URL du serveur, par exemple ftp://server.example.com, et les informations d’identification requises.

Des connexions sécurisées sont toujours établies quel que soit le protocole spécifié (ftp:// ou ftps://) si le serveur cible prend en charge FTPS. Pour autoriser uniquement les connexions sécurisées, utilisez le ftps:// protocole, par exemple ftps://server.example.com. Les connexions aux serveurs qui ne prennent pas en charge FTPS échouent si ftps:// est spécifié.


serverUrl - URL du serveur
string. Nécessaire lorsque credsType = inputs.

Spécifie l’URL du serveur FTP.


username - Nom d'utilisateur
string. Nécessaire lorsque credsType = inputs.

Spécifie le nom d’utilisateur de la connexion FTP.


password - Mot de passe
string. Nécessaire lorsque credsType = inputs.

Spécifie le mot de passe de la connexion FTP.


implicitFTPS - Utiliser ftps implicites
boolean. Valeur par défaut : false.


rootDirectory - Dossier racine
Alias d’entrée : rootFolder. string. Obligatoire.

Spécifie le dossier source à partir duquel charger les fichiers.


filePatterns - Modèles de fichiers
string. Obligatoire. Valeur par défaut : **.

Spécifie les chemins d’accès aux fichiers ou les modèles des fichiers à charger. La chaîne prend en charge plusieurs lignes de modèles mini-correspondance. En savoir plus sur les modèles de correspondance de fichiers.


remoteDirectory - Répertoire distant
Alias d’entrée : remotePath. string. Obligatoire. Valeur par défaut : /upload/$(Build.BuildId)/.

Spécifie le répertoire sur le serveur FTP distant où la tâche charge les fichiers.


enableUtf8 - Activer la prise en charge d’UTF8
boolean. Valeur par défaut : false.

Active la prise en charge d’UTF-8 pour la connexion FTP (OPTS UTF8 ON).


clean - Supprimer le répertoire distant
boolean. Valeur par défaut : false.

Supprime le répertoire distant, y compris son contenu, avant le chargement.


cleanContents - Effacer le contenu du répertoire distant
boolean. facultatif. Utilisez quand clean = false. Valeur par défaut : false.

Supprime de manière récursive tout le contenu du répertoire distant avant le chargement. Le répertoire existant ne sera pas supprimé. Pour de meilleures performances, utilisez clean plutôt.


preservePaths - Conserver les chemins d’accès aux fichiers
boolean. Valeur par défaut : false.

Si cette option est sélectionnée, la structure de répertoires locaux relative est recréée sous le répertoire distant où les fichiers sont chargés. Sinon, les fichiers sont chargés directement dans le répertoire distant sans créer de sous-répertoires supplémentaires.

Par exemple, supposons que votre dossier source est /home/user/source/, qui contient le fichier foo/bar/foobar.txt, et que votre répertoire distant est : /uploads/. Si cette valeur booléenne est sélectionnée, le fichier est chargé dans /uploads/foo/bar/foobar.txt. Si ce booléen n’est pas sélectionné, le fichier est chargé dans /uploads/foobar.txt.


trustSSL - Certificat de serveur d’approbation
boolean. Valeur par défaut : false.

Approuve le certificat SSL du serveur FTP avec ftps://, même s’il est auto-signé ou ne peut pas être validé par une autorité de certification.


customCmds - Commandes FTP
string.

Commandes FTP facultatives qui seront envoyées au serveur FTP distant lors de la connexion.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche pour charger des fichiers sur un ordinateur distant à l’aide de FTP ou de manière sécurisée avec FTPS.

Où puis-je en savoir plus sur les modèles de correspondance de fichiers ?

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Cette tâche s’exécute à l’aide des restrictions de commande suivantes : restricted
Variables settables Cette tâche est autorisée à définir les variables suivantes : La définition des variables est désactivée
Version de l’agent 2.182.1 ou version ultérieure
Catégorie de la tâche Utilitaire
Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Agent, DeploymentGroup
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Quelconque
Variables settables Quelconque
Version de l’agent Toutes les versions d’agent prises en charge.
Catégorie de la tâche Utilitaire

Voir aussi