tarefa PowerShell@1 – PowerShell v1
Execute um script do PowerShell.
Sintaxe
# PowerShell v1
# Run a PowerShell script.
- task: PowerShell@1
inputs:
scriptType: 'filePath' # 'inlineScript' | 'filePath'. Required. Type. Default: filePath.
scriptName: # string. Required when scriptType = filePath. Script Path.
#arguments: # string. Arguments.
#inlineScript: # string. Required when scriptType = inlineScript. Inline Script.
# Advanced
#workingFolder: # string. Working folder.
#failOnStandardError: true # boolean. Fail on Standard Error. Default: true.
Entradas
scriptType
- Tipo
string
. Obrigatórios. Valores permitidos: inlineScript
(Script Embutido) filePath
(Caminho do Arquivo). Valor padrão: filePath
.
Especifica o tipo de script para a tarefa ser executada: um script embutido ou um caminho para um .ps1
arquivo.
scriptName
- Caminho do script
string
. Obrigatório quando scriptType = filePath
.
Especifica o tipo de script para a tarefa ser executada: um script embutido ou um caminho para um .ps1
arquivo.
arguments
- Argumentos
string
.
Especifica os argumentos passados para o script do PowerShell. Os argumentos podem ser parâmetros ordinais ou parâmetros nomeados. Por exemplo, -Name someName -Path -Value "Some long string value"
.
arguments
não é usado quando é definido inline
como targetType
.
workingFolder
- Pasta de trabalho
string
.
Especifica o diretório de trabalho em que o script é executado. Se um valor não for especificado, o diretório de trabalho será $(Build.SourcesDirectory)
.
inlineScript
- Script embutido
string
. Obrigatório quando scriptType = inlineScript
. Valor padrão: # You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host "Hello World"
.
Especifica o conteúdo do script. O comprimento máximo do script embutido com suporte é de 500 caracteres. Use um script de um arquivo se quiser usar um script mais longo.
failOnStandardError
- Falha no Erro Padrão
boolean
. Valor padrão: true
.
Se o valor desse booliano for true
, a tarefa falhará se algum erro for gravado no pipeline de erro ou se algum dado for gravado no fluxo de Erro Padrão. Caso contrário, a tarefa depende do código de saída para determinar a falha.
Opções de controle da tarefa
Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.
Variáveis de saída
Nenhum.
Comentários
PowerShell@1
é executado somente em agentes do Windows. Para executar o PowerShell em outros tipos de agente, use PowerShell@2.
Cada sessão do PowerShell dura apenas enquanto o trabalho é executado. As tarefas que dependem do que foi inicializado devem estar no mesmo trabalho que a inicialização.
Definir uma variável para que ela possa ser lida por scripts e tarefas subsequentes
Para saber mais sobre como definir variáveis de build em um script, confira Definir e modificar suas variáveis de build em um script.
Para saber mais sobre como definir variáveis de versão em um script, consulte Definir e modificar suas variáveis de versão em um script.
Passar segredos de pipeline no script, mas o segredo não é mascarado em logs de pipeline
Lembre-se de que o PowerShell corta mensagens de erro, portanto, se você usar segredos de pipeline em um script, os segredos poderão ser cortados e expostos. Por exemplo, no script embutido abaixo:
./script.ps1 --arg1 value1 --arg2 <some_secret_which_will_be_masked_here>
Pode haver uma exceção como: At <path_to_temp_script_file>:4 char:3
:
+ ./script.ps1 --arg1 value1 --arg2 <unmasked_part_of_original_secret> ...
+ ~~~~~~~~~~
+ <Additional exception details>
Para evitar esse problema, você pode lidar com essas exceções em um nível de script ou evitar casos em que segredos de pipeline possam aparecer em linhas de código-fonte dentro de mensagens de erro.
Requisitos
Requisito | Descrição |
---|---|
Tipos de pipeline | YAML, build clássico, versão clássica |
É executado em | Agent, DeploymentGroup |
Demandas | Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam esta tarefa: DotNetFramework |
Funcionalidades | Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho. |
Restrições de comando | Qualquer |
Variáveis configuráveis | Qualquer |
Versão do agente | 1.102 ou superior |
Categoria da tarefa | Utilitário |