Delen via


steps.powershell definition

Met de powershell stap wordt een script uitgevoerd met Windows PowerShell (in Windows) of pwsh (Linux en macOS).

steps:
- powershell: string # Required as first property. Inline PowerShell script.
  errorActionPreference: string # Unless otherwise specified, the error action preference defaults to the value stop. See the following section for more information.
  failOnStderr: string # Fail the task if output is sent to Stderr?
  ignoreLASTEXITCODE: string # Check the final exit code of the script to determine whether the step succeeded?
  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: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  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:
- powershell: string # Required as first property. Inline PowerShell script.
  errorActionPreference: string # Unless otherwise specified, the error action preference defaults to the value stop. See the following section for more information.
  failOnStderr: string # Fail the task if output is sent to Stderr?
  ignoreLASTEXITCODE: string # Check the final exit code of the script to determine whether the step succeeded?
  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: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

Definities die naar deze definitie verwijzen: stappen

Eigenschappen

powershell tekenreeks. Vereist als eerste eigenschap.
PowerShell-script inline.

errorActionPreference tekenreeks.
Tenzij anders opgegeven, wordt de standaardwaarde van de foutactievoorkeur ingesteld op de waardestop. Zie de volgende sectie voor meer informatie.

failOnStderr tekenreeks.
Mislukt de taak als uitvoer naar Stderr wordt verzonden?

ignoreLASTEXITCODE tekenreeks.
Controleer de laatste afsluitcode van het script om te bepalen of de stap is geslaagd?

workingDirectory tekenreeks.
het script starten met deze werkmap.

condition tekenreeks.
Evalueer deze voorwaardeexpressie om te bepalen of deze taak moet worden uitgevoerd.

continueOnError booleaanse.
Doorgaan met uitvoeren, zelfs bij een fout?

displayName tekenreeks.
leesbare naam voor de taak.

target doel.
Omgeving waarin deze taak moet worden uitgevoerd.

enabled booleaanse.
Deze taak uitvoeren wanneer de taak wordt uitgevoerd?

env tekenreekswoordenlijst.
variabelen die moeten worden toegewezen aan de omgeving van het proces.

name tekenreeks.
id van de stap. Acceptabele waarden: [-_A-Za-z0-9]*.

timeoutInMinutes tekenreeks.
Tijd om te wachten tot deze taak is voltooid voordat de server deze doodt.

Notitie

Pijplijnen kunnen worden geconfigureerd met een time-out op taakniveau. Als het time-outinterval op taakniveau is verstreken voordat de stap is voltooid, wordt de actieve taak (inclusief uw stap) beëindigd, zelfs als de stap is geconfigureerd met een langer timeoutInMinutes interval. Zie Time-outsvoor meer informatie.

retryCountOnTaskFailure tekenreeks.
aantal nieuwe pogingen als de taak mislukt.

Opmerkingen

Het powershell trefwoord is een snelkoppeling voor de PowerShell-taak. De taak voert een script uit met Windows PowerShell (in Windows) of pwsh (Linux en macOS).

Elke PowerShell-sessie duurt alleen voor de duur van de taak waarin deze wordt uitgevoerd. Taken die afhankelijk zijn van wat is opgestart, moeten zich in dezelfde taak bevinden als de bootstrap.

Meer informatie over voorwaarden en time-outs.

Foutactievoorkeur

Tenzij anders opgegeven, wordt de voorkeur voor foutactie standaard ingesteld op de waarde stopen wordt de regel $ErrorActionPreference = 'stop' boven aan het script voorafgegaan.

Wanneer de voorkeur voor foutacties is ingesteld om te stoppen, veroorzaken fouten dat PowerShell de taak beëindigt en een niet-nul-afsluitcode retourneert. De taak is ook gemarkeerd als Mislukt.

errorActionPreference: stop | continue | silentlyContinue
steps:
- powershell: |
    Write-Error 'Uh oh, an error occurred'
    Write-Host 'Trying again...'
  displayName: Error action preference
  errorActionPreference: continue

Laatste afsluitcode negeren

De laatste afsluitcode die door uw script wordt geretourneerd, wordt standaard gecontroleerd. Een niet-nulcode geeft een stapfout aan. In dat geval voegt het systeem uw script toe met:

if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE }

Als u dit gedrag niet wilt, geeft u ignoreLASTEXITCODE: trueop.

ignoreLASTEXITCODE: boolean
steps:
- powershell: git nosuchcommand
  displayName: Ignore last exit code
  ignoreLASTEXITCODE: true

Meer informatie over voorwaarden en time-outs.

Voorbeelden

steps:
- powershell: Write-Host Hello $Env:name
  displayName: Say hello
  name: firstStep
  workingDirectory: $(build.sourcesDirectory)
  failOnStderr: true
  env:
    name: Microsoft

Zie ook