steps.powershell definition

  • Artigo

O powershell passo executa um script com Windows PowerShell (no Windows) ou pwsh (Linux e 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.

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

Definições que referenciam esta definição: passos

Propriedades

powershell cadeia. Necessário como primeira propriedade.
Script inline do PowerShell.

errorActionPreference cadeia.
Salvo especificação em contrário, a preferência de ação de erro é predefinida para a paragem de valor. Veja a secção seguinte para obter mais informações.

failOnStderr cadeia.
Falha na tarefa se a saída for enviada para Stderr?

ignoreLASTEXITCODE cadeia.
Verifique o código de saída final do script para determinar se o passo foi bem-sucedido?

workingDirectory cadeia.
Inicie o script com este diretório de trabalho.

condition cadeia.
Avalie esta expressão de condição para determinar se deve executar esta tarefa.

continueOnErrorbooleano.
Continuar a executar mesmo com falhas?

displayName cadeia.
Nome legível por humanos para a tarefa.

targetdestino.
Ambiente para executar esta tarefa.

enabledbooleano.
Executar esta tarefa quando a tarefa for executada?

env dicionário de cadeias.
Variáveis a mapear para o ambiente do processo.

name cadeia.
ID do passo. Valores aceitáveis: [-_A-Za-z0-9]*.

timeoutInMinutes cadeia.
Hora de aguardar que esta tarefa seja concluída antes que o servidor a mate.

Nota

Os pipelines podem ser configurados com um tempo limite ao nível da tarefa. Se o intervalo de tempo limite do nível da tarefa decorrido antes da conclusão do passo, a tarefa de execução (incluindo o passo) será terminada, mesmo que o passo esteja configurado com um intervalo mais longo timeoutInMinutes . Para obter mais informações, veja Tempos Limite.

retryCountOnTaskFailure cadeia.
Número de tentativas se a tarefa falhar.

Observações

A powershell palavra-chave é um atalho para a tarefa do PowerShell. A tarefa executa um script com Windows PowerShell (no Windows) ou pwsh (Linux e macOS).

Cada sessão do PowerShell dura apenas a duração da tarefa em que é executada. As tarefas que dependem do que foi iniciado têm de estar no mesmo trabalho que o bootstrap.

Saiba mais sobre condições e tempos limite.

Preferência de ação de erro

Salvo especificação em contrário, a preferência de ação de erro é predefinida para o valor stope a linha $ErrorActionPreference = 'stop' é pré-anexada à parte superior do script.

Quando a preferência de ação de erro está definida para parar, os erros fazem com que o PowerShell termine a tarefa e devolva um código de saída nãozero. A tarefa também está marcada como Falha.

errorActionPreference: stop | continue | silentlyContinue

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

Ignorar o último código de saída

O último código de saída devolvido do script é verificado por predefinição. Um código nãozero indica uma falha de passo, caso em que o sistema acrescenta o script com:

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

Se não quiser este comportamento, especifique ignoreLASTEXITCODE: true.

ignoreLASTEXITCODE: boolean

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

Saiba mais sobre condições e tempos limite.

Exemplos

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

Ver também