BatchScript@1 - Uppgift för Batchskript v1

2025-06-24

Använd den här uppgiften för att köra ett Windows .bat eller .cmd skript. Du kan också använda skriptet .bat or .cmd för att permanent ändra miljövariabler.

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.

Ingångar

filename - Sökväg
string. Obligatoriskt.

Sökvägen till det eller-skript .bat som .cmd ska köras. Detta bör vara en fullständigt kvalificerad sökväg eller en i förhållande till standardarbetskatalogen. (Observera att arbetskatalogen kan skilja sig från workingFolder, som kan anges för den här uppgiften.)

arguments - argument
string.

Argumenten som skickas till skriptet .cmd eller .bat .

modifyEnvironment - Ändra miljö
boolean. Standardvärde: False.

Avgör om ändringar av miljövariabler kommer att påverka efterföljande uppgifter.

workingFolder - Arbetsmapp
string.

Den aktuella arbetskatalogen när ett skript körs. Detta är som standard den mapp där skriptet finns.

failOnStandardError - fel vid standardfel
boolean. Standardvärde: false.

Om detta är sant misslyckas den här uppgiften om några fel skrivs till StandardError dataströmmen.

Alternativ för uppgiftskontroll

Alla aktiviteter har kontrollalternativ utöver sina uppgiftsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Ingen.

Anmärkningar

Använd den här uppgiften för att köra ett Windows-.bat eller .cmd skript. Du kan också tillåta att den permanent ändrar miljövariabler.

Anmärkning

Den här uppgiften är inte kompatibel med Windows-containrar. Om du behöver köra ett batchskript på en Windows-container använder du kommandoradsaktiviteten i stället.

Information om hur du stöder flera plattformar finns i plattformsoberoende skript.

Exempel

Skapa test.bat i roten på ditt lagringsutrymme:

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

Om du vill köra det här skriptet lägger du till följande uppgift i din pipeline.

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

Kravspecifikation

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
Krav	Lokalt installerade agenter måste ha funktioner som matchar följande kräver för att köra jobb som använder den här uppgiften: Cmd
Kapaciteter	Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet.
Kommandobegränsningar	Vilken som helst
variabler som kan	Vilken som helst
Agentversion	1.83.0 eller senare
Aktivitetskategori	Nyttighet

Dela via