Partager via


BatchScript@1 - Tâche de script batch v1

La procédure décrite ci-dessous permet d’exécuter un Windows .bat ou .cmd un script. Le script ou .cmd peut éventuellement modifier de façon permanente les .bat variables d’environnement.

Syntaxe

# Batch script v1
# Run a Windows command or batch script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

Données d'entrée

filename - chemin d’accès
string. Obligatoire.

Chemin d’accès du .cmd script ou .bat à exécuter. Il doit s’agir d’un chemin complet ou d’un chemin d’accès par rapport au répertoire de travail par défaut. (Veuillez noter que le répertoire de travail peut différer de workingFolder, qui peut être spécifié pour cette tâche.)


arguments - arguments
string.

Les arguments sont passés au .cmd script or .bat .


modifyEnvironment - Modifier l’environnement
boolean. Valeur par défaut : False.

Détermine si les modifications apportées aux variables d’environnement affecteront les tâches suivantes.


workingFolder - dossier de travail
string.

Répertoire de travail courant lors de l’exécution d’un script. Par défaut, il s’agit du dossier dans lequel se trouve le script.


failOnStandardError - Échec sur les d’erreur standard
boolean. Valeur par défaut : false.

Si cela est vrai, cette tâche échoue si des erreurs sont écrites dans le flux de StandardError.


Options de contrôle de tâche

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

Variables de sortie

Aucun.

Remarques

La procédure décrite ci-dessous permet d’exécuter un script Windows .bat ou .cmd. Si vous le souhaitez, permettez-lui de modifier de façon permanente les variables d’environnement.

Remarque

Cette tâche n’est pas compatible avec les conteneurs Windows. Si vous devez exécuter un script batch sur un conteneur Windows, utilisez plutôt la tâche de ligne de commande .

Pour plus d’informations sur la prise en charge de plusieurs plates-formes, consultez Scripts multiplateformes.

Exemples

Créez test.bat à la racine de votre dépôt :

@echo off
echo Hello World from %AGENT_NAME%.
echo My ID is %AGENT_ID%.
echo AGENT_WORKFOLDER contents:
@dir %AGENT_WORKFOLDER%
echo AGENT_BUILDDIRECTORY contents:
@dir %AGENT_BUILDDIRECTORY%
echo BUILD_SOURCESDIRECTORY contents:
@dir %BUILD_SOURCESDIRECTORY%
echo Over and out.

Pour exécuter ce script, ajoutez la tâche suivante à votre pipeline.

- task: BatchScript@1
  inputs:
    filename: 'test.bat'

Spécifications

Besoin Descriptif
Types de pipelines YAML, Build Classique, Version Classique
Exécutions sur Agent, DeploymentGroup
demandes Les agents auto-hébergés doivent disposer de fonctionnalités qui correspondent aux exigences de suivantes pour exécuter des travaux qui utilisent cette tâche : Cmd
Capacités Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe lequel
variables settables N'importe lequel
Version de l’agent 1.83.0 ou version ultérieure
Catégorie de tâche Utilité