BatchScript@1: tarea Script de Batch v1

Artículo
04/16/2024

Use esta tarea para ejecutar un script o .cmd Windows.bat. Opcionalmente, el .bat script o .cmd puede modificar permanentemente variables de entorno.

Sintaxis

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

# Batch Script v1
# Run a windows cmd or bat 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.

Entradas

filename - Camino
string. Obligatorio.

Ruta de acceso .cmd del script o .bat que se va a ejecutar. Debe ser una ruta de acceso completa o una relativa al directorio de trabajo predeterminado. (Tenga en cuenta que el directorio de trabajo podría diferir de workingFolder, que podría especificarse para esta tarea).

arguments - Argumentos
string.

Argumentos pasados al .cmd script o .bat .

modifyEnvironment - Modificar entorno
boolean. Valor predeterminado: False.

Determina si las modificaciones de variables de entorno afectarán a las tareas posteriores.

workingFolder - Carpeta de trabajo
string.

Directorio de trabajo actual cuando se ejecuta un script. Este valor predeterminado es la carpeta donde se encuentra el script.

failOnStandardError - Error en el error estándar
boolean. Valor predeterminado: false.

Si esto es cierto, se producirá un error en esta tarea si se escribe algún error en la StandardError secuencia.

Opciones de control de tareas

Todas las tareas tienen opciones de control además de sus entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Observaciones

Use esta tarea para ejecutar un script de windows .bat o .cmd. Opcionalmente, permita modificar de forma permanente las variables de entorno.

Nota

Esta tarea no es compatible con los contenedores de Windows. Si necesita ejecutar un script por lotes en un contenedor de Windows, use la tarea de línea de comandos en su lugar.

Para obtener información sobre cómo admitir varias plataformas, consulte Scripting multiplataforma.

Ejemplos

Cree test.bat en la raíz del repositorio:

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

Para ejecutar este script, agregue la siguiente tarea a la canalización.

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

Requisitos

Requisito	Descripción
Tipos de canalización	YAML, compilación clásica, versión clásica
Se ejecuta en	Agente, DeploymentGroup
Peticiones	Los agentes autohospedados deben tener funcionalidades que coincidan con las siguientes demandas para ejecutar trabajos que usen esta tarea: Cmd
Capabilities	Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos	Any
Variables que se pueden establecer	Any
Versión del agente	1.83.0 o superior
Categoría de la tarea:	Utilidad