BatchScript@1 – Batchskript v1-Aufgabe

Artikel
07/02/2024

Verwenden Sie diese Aufgabe, um ein Windows .bat - oder .cmd Skript auszuführen. Optional kann das .bat Skript oder .cmd Umgebungsvariablen dauerhaft ändern.

Syntax

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

Eingaben

filename - Pfad
string. Erforderlich.

Der Pfad des .cmd auszuführenden Skripts oder .bat . Hierbei sollte es sich um einen vollqualifizierten Pfad oder einen pfad relativ zum Standardarbeitsverzeichnis handeln. (Beachten Sie, dass sich das Arbeitsverzeichnis von unterscheiden workingFolderkann, das für diese Aufgabe angegeben werden könnte.)

arguments - Argumente
string.

Die Argumente, die an das .cmd Skript oder .bat übergeben werden.

modifyEnvironment - Umgebung ändern
boolean. Standardwert. False.

Bestimmt, ob Änderungen von Umgebungsvariablen sich auf nachfolgende Aufgaben auswirken.

workingFolder - Arbeitsordner
string.

Das aktuelle Arbeitsverzeichnis, wenn ein Skript ausgeführt wird. Dies ist standardmäßig der Ordner, in dem sich das Skript befindet.

failOnStandardError - Fehler beim Standardfehler
boolean. Standardwert. false.

Wenn dies wahr ist, tritt bei dieser Aufgabe ein Fehler auf, wenn Fehler in den StandardError Stream geschrieben werden.

Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu den Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Verwenden Sie diese Aufgabe, um ein Windows-.bat- oder CMD-Skript auszuführen. Optional können Sie umgebungsvariablen dauerhaft ändern.

Hinweis

Diese Aufgabe ist nicht mit Windows-Containern kompatibel. Wenn Sie ein Batchskript für einen Windows-Container ausführen müssen, verwenden Sie stattdessen den Befehlszeilentask .

Informationen zur Unterstützung mehrerer Plattformen finden Sie unter Plattformübergreifende Skripterstellung.

Beispiele

Erstellen Sie test.bat am Stamm Ihres Repositorys:

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

Um dieses Skript auszuführen, fügen Sie der Pipeline die folgende Aufgabe hinzu.

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

Anforderungen

Anforderung	Beschreibung
Pipelinetypen	YAML, Klassischer Build, klassische Version
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Selbstgehostete Agents müssen über Funktionen verfügen, die den folgenden Anforderungen entsprechen , um Aufträge auszuführen, die diese Aufgabe verwenden: Cmd
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	1.83.0 oder höher
Aufgabenkategorie	Hilfsprogramm

Freigeben über