Partilhar via

definição steps.powershell

A etapa powershell executa um script usando o Windows PowerShell (no Windows) ou o 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.

Definições que fazem referência a esta definição: etapas

Propriedades

powershell string. Obrigatório como primeira propriedade.
Script do PowerShell em linha.

errorActionPreference string.
A menos que especificado de outra forma, a preferência de ação de erro assume como padrão o valor stop. Consulte a seção a seguir para obter mais informações.

failOnStderr string.
Falhar a tarefa se a saída for enviada para Stderr?

ignoreLASTEXITCODE string.
Verifique o código de saída final do script para determinar se a etapa foi bem-sucedida?

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

condition string.
Avalie essa expressão de condição para determinar se essa tarefa deve ser executada.

continueOnError booleano.
Continuar a correr mesmo em caso de falha?

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

target alvo.
Ambiente no qual executar esta tarefa.

enabled booleano.
Executar esta tarefa quando o trabalho é executado?

env dicionário de cordas.
Variáveis a serem mapeadas no ambiente do processo.

name string.
ID da etapa. Valores aceitáveis: [-_A-Za-z0-9]*.

timeoutInMinutes string.
Tempo para esperar que esta tarefa seja concluída antes que o servidor a mate.

Observação

Os pipelines podem ser configurados com um tempo limite de nível de trabalho. Se o intervalo de tempo limite do nível do trabalho decorrer antes da conclusão da etapa, o trabalho em execução (incluindo a etapa) será encerrado, mesmo que a etapa esteja configurada com um intervalo de timeoutInMinutes maior. Para obter mais informações, consulte Tempos limite.

retryCountOnTaskFailure string.
Número de novas tentativas se a tarefa falhar.

Observações

A palavra-chave powershell é um atalho para o de tarefas doPowerShell. A tarefa executa um script usando o Windows PowerShell (no Windows) ou o pwsh (Linux e macOS).

Cada sessão do PowerShell dura apenas a duração do trabalho em que é executada. As tarefas que dependem do que foi inicializado devem estar no mesmo trabalho que o bootstrap.

Saiba mais sobre condições e tempos limite.

Preferência de ação de erro

A menos que especificado de outra forma, a preferência de ação de erro assume como padrão o valor stop, e a linha $ErrorActionPreference = 'stop' é anexada à parte superior do script.

Quando a preferência de ação de erro é definida para parar, os erros fazem com que o PowerShell encerre a tarefa e retorne um código de saída diferente de zero. A tarefa também é 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 retornado do script é verificado por padrão. Um código diferente de zero indica uma falha de etapa, caso em que o sistema acrescenta seu script com:

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

Se você não quiser esse 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 $Env:name
  displayName: Say hello
  name: firstStep
  workingDirectory: $(build.sourcesDirectory)
  failOnStderr: true
  env:
    name: Microsoft

Ver também