BatchScript@1 – Batch-skript v1-uppgift

Artikel
07/02/2024

Använd den här uppgiften för att köra ett Windows .bat - eller .cmd skript. Alternativt kan skriptet .bat eller .cmd 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.

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

Indata

filename - Sökvägen
string. Krävs.

Sökvägen till skriptet .cmd eller .bat som 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 aktiviteten.)

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 påverkar efterföljande uppgifter.

workingFolder - Arbetsmapp
string.

Den aktuella arbetskatalogen när ett skript körs. Detta är standard för mappen 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 dataströmmen StandardError .

Alternativ för aktivitetskontroll

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

Utdatavariabler

Inga.

Kommentarer

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.

Anteckning

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 stöd för flera plattformar finns i skript för flera plattformar.

Exempel

Skapa test.bat i roten på lagringsplatsen:

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

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

Krav

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 krav för att köra jobb som använder den här uppgiften: Cmd
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	1.83.0 eller senare
Uppgiftskategori	Verktyg

Dela via