BatchScript@1 - 批处理脚本 v1 任务

  • 项目

使用此任务运行 Windows .bat 或 .cmd 脚本。 .bat（可选）或 .cmd 脚本可以永久修改环境变量。

语法

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

输入

filename - 路径
string. 必需。

要执行的 或 .bat 脚本的路径.cmd。 这应该是完全限定的路径或相对于默认工作目录的路径。 (请注意，工作目录可能与 （可为此 task 指定）不同 workingFolder。)


arguments - 参数
string.

传递给 或 .bat 脚本的参数.cmd。


modifyEnvironment - 修改环境
boolean. 默认值：False。

确定环境变量修改是否会影响后续任务。


workingFolder - 工作文件夹
string.

运行脚本时的当前工作目录。 这默认为脚本所在的文件夹。


failOnStandardError - 标准错误失败
boolean. 默认值：false。

如果为 true，则向流中写入任何错误时， StandardError 此任务将失败。


任务控件选项

除任务输入外，所有任务都有控制选项。 有关详细信息，请参阅 控制选项和常见任务属性。

输出变量

无。

备注

使用此任务运行 Windows .bat 或 .cmd 脚本。 （可选）允许它永久修改环境变量。

注意

此任务与 Windows 容器不兼容。 如果需要在 Windows 容器上运行批处理脚本，请改用 命令行任务 。

有关支持多个平台的信息，请参阅 跨平台脚本。

示例

在存储库的根目录中创建 test.bat ：

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

若要运行此脚本，请将以下任务添加到管道。

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

要求

要求 说明
管道类型 YAML，经典内部版本，经典发布
运行平台 Agent、DeploymentGroup
需求 自承载代理必须具有满足以下要求的功能才能运行使用此任务的作业：Cmd
功能 此任务不满足作业中后续任务的任何要求。
命令限制 Any
可设置的变量 Any
代理版本 1.83.0 或更高版本
任务类别 实用工具