Partilhar via

Write-Warning

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

Escreve uma mensagem de aviso.

Sintaxe

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

Description

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

Exemplos

Exemplo 1: Escrever uma mensagem de aviso

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

Write-Warning "This is only a test warning."

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

Este 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, como mostrado neste comando, ou canalizá-la diretamente para Write-Warning.

$w = "This is only a test warning."
$w | Write-Warning

Exemplo 3: Definir a variável $WarningPreference e escrever um aviso

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

PS> $WarningPreference
Continue
PS> Write-Warning "This is only a test warning."
This is only a test warning.
PS> $WarningPreference = "SilentlyContinue"
PS> Write-Warning "This is only a test warning."
PS> $WarningPreference = "Stop"
PS> Write-Warning "This is only a test warning."
WARNING: This is only a test warning.
Write-Warning: The running command stopped because the preference variable "WarningPreference" or common parameter is set to Stop: This is only a test warning.

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

Quando você altera o valor da variável $WarningPreference, o efeito do comando Write-Warning muda novamente. Um valor de SilentlyContinue suprime o aviso. Um valor de Stop exibe o aviso e, em seguida, 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 escrever um aviso

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

PS> 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 comando usa o cmdlet Write-Warning para exibir um aviso. O WarningAction parâmetro comum 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 WarningAction parâmetro comum, consulte about_CommonParameters.

Parâmetros

-Message

Especifica a mensagem de aviso.

Tipo:String
Aliases:Msg
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

Entradas

String

Você pode canalizar uma cadeia de caracteres que contém o aviso para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída. Ele grava apenas no fluxo de aviso.

Notas

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