Compartilhar via

Write-Warning

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Grava uma mensagem de aviso.

Syntax

Write-Warning
     [-Message] <String>
     [<CommonParameters>]

Description

O cmdlet Write-Warning grava uma mensagem de aviso no host Windows PowerShell. A resposta ao aviso depende do valor da variável $WarningPreference do usuário e do uso do parâmetro comum WarningAction .

Exemplos

Exemplo 1: Escrever uma mensagem de aviso

PS C:\> Write-Warning "This is only a test warning."

Esse comando exibe a mensagem "AVISO: este é apenas um aviso de teste".

Exemplo 2: passar uma cadeia de caracteres para Write-Warning

PS C:\> $w = "This is only a test warning."
PS C:\> $w | Write-Warning

Esse comando mostra que você pode usar um operador de pipeline (|) para enviar uma cadeia de caracteres para Write-Warning. Você pode salvar a cadeia de caracteres em uma variável, conforme mostrado neste comando, ou redirecionar a cadeia de caracteres diretamente para Write-Warning.

Exemplo 3: definir a variável $WarningPreference e gravar um aviso

PS C:\> $warningpreference
Continue PS C:\> Write-Warning "This is only a test warning."
This is only a test warning. PS C:\> $warningpreference = "SilentlyContinue"
PS C:\> Write-Warning "This is only a test warning."
PS C:\>
PS C:\> $warningpreference = "Stop"
PS C:\> Write-Warning "This is only a test warning."
WARNING: This is only a test message.
Write-Warning : Command execution stopped because the shell variable "WarningPreference" is set to Stop.
At line:1 char:14
     + Write-Warning <<<<  "This is only a test message."

Este exemplo mostra o efeito do valor da variável $WarningPreference em um comando Write-Warning .

O primeiro comando exibe o valor padrão da variável $WarningPreference, que é Continuar. Como resultado, quando você escreve um aviso, a mensagem de aviso será exibida e a execução continuará.

Quando você altera o valor da variável $WarningPreference, o efeito do comando Write-Warning é alterado novamente. Um valor de SilentlyContinue suprime o aviso. Um valor de Parar exibe o aviso e interrompe a execução do comando.

Para obter mais informações sobre a variável $WarningPreference, consulte about_Preference_Variables.

Exemplo 4: definir o parâmetro WarningAction e gravar um aviso

PS C:\> Write-Warning "This is only a test warning." -WarningAction Inquire
WARNING: This is only a test warning.
Confirm
Continue with this operation?
 [Y] Yes  [A] Yes to All  [H] Halt Command  [S] Suspend  [?] Help (default is "Y"):

Este exemplo mostra o efeito do parâmetro comum WarningAction em um comando Write-Warning . Você pode usar o parâmetro comum WarningAction com qualquer cmdlet para determinar como Windows PowerShell responde a avisos resultantes desse comando. O parâmetro comum WarningAction substitui o valor do $WarningPreference somente para esse comando específico.

Esse comando usa o cmdlet Write-Warning para exibir um aviso. O parâmetro comum WarningAction com um valor de Inquire direciona o sistema para avisar o usuário quando o comando exibe um aviso.

Para obter mais informações sobre o parâmetro comum WarningAction , consulte about_CommonParameters.

Parâmetros

-Message

Especifica a mensagem de aviso.

Type:String
Aliases:Msg
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Entradas

String

Você pode redirecionar uma cadeia de caracteres que contém o aviso para Write-Warning.

Saídas

None

Write-Warning grava somente no fluxo de aviso. Ele não gera outras saídas.

Observações

  • O valor padrão para a variável $WarningPreference é Continue, que exibe o aviso e continua executando o comando. Para determinar os valores válidos para uma variável de preferência como $WarningPreference, defina-o como uma cadeia de caracteres aleatórios, como "abc". A mensagem de erro resultante listará os valores válidos.