Freigeben über

steps.powershell definition

  • Artikel

Der powershell Schritt führt ein Skript entweder mit Windows PowerShell (unter Windows) oder pwsh (Linux und macOS) aus.

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.

Definitionen, die auf diese Definition verweisen: Schritte

Eigenschaften

powershell Zeichenfolge. Erforderlich als erste Eigenschaft.
Inline-PowerShell-Skripts.

errorActionPreference Zeichenfolge.
Sofern nicht anders angegeben, wird die Fehleraktionseinstellung standardmäßig auf den Wertstopp festgelegt. Weitere Informationen finden Sie im folgenden Abschnitt.

failOnStderr Zeichenfolge.
Schlägt die Aufgabe fehl, wenn die Ausgabe an Stderr gesendet wird?

ignoreLASTEXITCODE Zeichenfolge.
Überprüfen Sie den endgültigen Beendigungscode des Skripts, um zu ermitteln, ob der Schritt erfolgreich war?

workingDirectory Zeichenfolge.
Starten des Skripts mit diesem Arbeitsverzeichnis.

condition Zeichenfolge.
Diesen Bedingungsausdruck auswerten, um zu bestimmen, ob diese Aufgabe ausgeführt werden soll.

continueOnError booleschen.
Auch bei Fehlern weiter ausgeführt werden?

displayName Zeichenfolge.
Lesbarer Name für den Vorgang.

target Ziel-.
Umgebung, in der diese Aufgabe ausgeführt werden soll.

enabled booleschen.
Diese Aufgabe ausführen, wenn der Auftrag ausgeführt wird?

env Zeichenfolgenwörterbuch.
Variablen, die der Umgebung des Prozesses zugeordnet werden sollen.

name Zeichenfolge.
ID des Schritts. Zulässige Werte: [-_A-Za-z0-9]*.

timeoutInMinutes Zeichenfolge.
Zeit, bis diese Aufgabe abgeschlossen ist, bevor der Server beendet wird.

Hinweis

Pipelines können mit einem Timeout auf Auftragsebene konfiguriert werden. Wenn das Zeitüberschreitungsintervall auf Auftragsebene vor Abschluss des Schritts verstrichen ist, wird der ausgeführte Auftrag (einschließlich Ihres Schritts) beendet, auch wenn der Schritt mit einem längeren timeoutInMinutes Intervall konfiguriert ist. Weitere Informationen finden Sie unter Timeouts.

retryCountOnTaskFailure Zeichenfolge.
Anzahl der Wiederholungen, wenn der Vorgang fehlschlägt.

Bemerkungen

Das schlüsselwort powershell ist eine Verknüpfung für die PowerShell-Aufgabe. Die Aufgabe führt ein Skript mit Windows PowerShell (unter Windows) oder pwsh (Linux und macOS) aus.

Jede PowerShell-Sitzung dauert nur für die Dauer des Auftrags, in dem sie ausgeführt wird. Aufgaben, die davon abhängen, was bootstrapped wurde, müssen sich im gleichen Auftrag wie der Bootstrap befinden.

Erfahren Sie mehr über Bedingungen und Timeouts.

Fehleraktionseinstellung

Sofern nicht anders angegeben, wird die Fehleraktionseinstellung standardmäßig auf den Wert stopfestgelegt, und die Zeile $ErrorActionPreference = 'stop' wird oben im Skript vorangestellt.

Wenn die Fehleraktionseinstellung auf das Beenden festgelegt ist, verursachen Fehler, dass PowerShell die Aufgabe beendet und einen nichtzero-Beendigungscode zurückgibt. Die Aufgabe ist auch als fehlgeschlagen gekennzeichnet.

errorActionPreference: stop | continue | silentlyContinue

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

Letzten Beendigungscode ignorieren

Der letzte von Ihrem Skript zurückgegebene Exitcode ist standardmäßig aktiviert. Ein Nichtzero-Code gibt einen Schrittfehler an. In diesem Fall fügt das System Ihr Skript an:

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

Wenn Sie dieses Verhalten nicht wünschen, geben Sie ignoreLASTEXITCODE: truean.

ignoreLASTEXITCODE: boolean

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

Erfahren Sie mehr über Bedingungen und Timeouts.

Beispiele

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

Siehe auch