steps.script definition
The script step runs a script using cmd.exe on Windows and Bash on other platforms.
steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
target: stepTarget # Environment in which to run this task
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.target
Environment in which to run this task.
enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
target: stepTarget # Environment in which to run this task
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.target
Environment in which to run this task.
enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
target: stepTarget # Environment in which to run this task
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
retryCountOnTaskFailure: string # Number of retries if the task fails.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.target
Environment in which to run this task.
enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [-_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.retryCountOnTaskFailure
string
Number of retries if the task fails.steps:
- script: string # Required as first property. An inline script.
failOnStderr: string # Fail the task if output is sent to Stderr?.
workingDirectory: string # Start the script with this working directory.
condition: string # Evaluate this condition expression to determine whether to run this task.
continueOnError: boolean # Continue running even on failure?. (false,n,no,off,on,true,y,yes)
displayName: string # Human-readable name for the task.
target: stepTarget # Environment in which to run this task
enabled: boolean # Run this task when the job runs?. (false,n,no,off,on,true,y,yes)
env: # Variables to map into the process's environment
string: string # Name/value pairs.
name: string # ID of the step. ([-_A-Za-z0-9]*)
timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
retryCountOnTaskFailure: string # Number of retries if the task fails.
Properties that use this definition: steps
Properties
script
string
Required as first parameter. An inline script.failOnStderr
string
Fail the task if output is sent to Stderr?workingDirectory
string
Start the script with this working directory.condition
string
Evaluate this condition expression to determine whether to run this task.continueOnError
boolean
Continue running even on failure?displayName
string
Human-readable name for the task.target
Environment in which to run this task.
enabled
boolean
Run this task when the job runs?env
string name/value pairs
Variables to map into the process's environment.name
string
ID of the step. Acceptable values: [-_A-Za-z0-9]*timeoutInMinutes
string
Time to wait for this task to complete before the server kills it.retryCountOnTaskFailure
string
Number of retries if the task fails.Remarks
The script keyword is a shortcut for the command-line task.
The task runs a script using cmd.exe on Windows and Bash on other platforms.
Learn more about conditions, timeouts, and step targets.
Examples
If you don't specify a command mode, you can shorten the target structure to:
- script:
target: string # container name or the word 'host'
steps:
- script: echo Hello world!
displayName: Say hello
See also
Feedback
Submit and view feedback for