Sdílet prostřednictvím

steps.powershell definition

Krok powershell spustí skript pomocí Windows PowerShellu (ve Windows) nebo pwsh (Linux a 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.

Definice, které odkazují na tuto definici: kroky

Vlastnosti

powershell řetězec. Povinné jako první vlastnost.
vložený skript PowerShellu.

errorActionPreference řetězec.
Pokud neurčíte jinak, předvolba akce chyby se nastaví jako výchozí hodnota zastavení. Další informace najdete v následující části.

failOnStderr řetězec.
Selhání úlohy, pokud je výstup odeslán do Stderr?

ignoreLASTEXITCODE řetězec.
Zkontrolujte konečný ukončovací kód skriptu a zjistěte, jestli byl krok úspěšný?

workingDirectory řetězec.
spuštění skriptu s tímto pracovním adresářem.

condition řetězec.
Vyhodnocení tohoto výrazu podmínky k určení, zda má být spuštěna tato úloha.

continueOnError logických.
Pokračovat i při selhání?

displayName řetězec.
název úkolu čitelný pro člověka.

target cílové.
prostředí, ve kterém chcete tuto úlohu spustit.

enabled logických.
Spustit tuto úlohu při spuštění úlohy?

env řetězcový slovník.
proměnné pro mapování do prostředí procesu.

name řetězec.
ID kroku. Přijatelné hodnoty: [-_A-Za-z0-9]*.

timeoutInMinutes řetězec.
Doba čekání na dokončení této úlohy před ukončením serveru.

Poznámka:

Kanály můžou být nakonfigurované s vypršením časového limitu na úrovni úlohy. Pokud časový limit na úrovni úlohy uplynul před dokončením kroku, je spuštěná úloha (včetně kroku) ukončena, i když je krok nakonfigurovaný s delším timeoutInMinutes intervalem. Další informace najdete v tématu vypršení časových limitů.

retryCountOnTaskFailure řetězec.
Počet opakování, pokud úloha selže.

Poznámky

Klíčové slovo powershell je zkratka pro úlohy powershellu. Úloha spustí skript pomocí Windows PowerShellu (ve Windows) nebo pwsh (Linux a macOS).

Každá relace PowerShellu trvá jenom po dobu trvání úlohy, ve které běží. Úlohy, které závisí na tom, co bylo spuštěno, musí být ve stejné úloze jako bootstrap.

Přečtěte si další informace o podmínkách a časových limitech .

Předvolba chybových akcí

Pokud neurčíte jinak, předvolba akce chyby se ve výchozím nastavení nastaví na hodnotu stopa řádek $ErrorActionPreference = 'stop' se předzálohuje na začátek skriptu.

Pokud je předvolba akce chyby nastavená na zastavení, chyby způsobí ukončení úlohy v PowerShellu a vrátí nenulový ukončovací kód. Úkol je také označen jako neúspěšný.

errorActionPreference: stop | continue | silentlyContinue

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

Ignorovat poslední ukončovací kód

Ve výchozím nastavení se zkontroluje poslední ukončovací kód vrácený z vašeho skriptu. Nenulový kód označuje selhání kroku, v takovém případě systém připojí váš skript pomocí:

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

Pokud toto chování nechcete, zadejte ignoreLASTEXITCODE: true.

ignoreLASTEXITCODE: boolean

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

Přečtěte si další informace o podmínkách a časových limitech .

Příklady

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

Viz také