Write-Warning
Grava uma mensagem de aviso.
Sintaxe
Default (Padrão)
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, conforme mostrado neste comando, ou redirecionar a cadeia de caracteres diretamente para Write-Warning.
$w = "This is only a test warning."
$w | Write-Warning
Exemplo 3: Definir a variável $WarningPreference e gravar 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 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
Este exemplo mostra o efeito do parâmetro comum WarningAction em um comando Write-Warning. Você pode usar o WarningAction parâmetro comum com qualquer cmdlet para determinar como o PowerShell responde a avisos resultantes desse comando. O WarningAction parâmetro comum substitui o valor do $WarningPreference somente 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"):
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 exibirá um aviso.
Para obter mais informações sobre o parâmetro comum WarningAction, consulte about_CommonParameters.
Parâmetros
-Message
Especifica a mensagem de aviso.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Msg |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
String
Você pode passar uma cadeia de caracteres que contém o aviso para este cmdlet.
Saídas
None
Esse cmdlet não retorna nenhuma saída. Ele escreve apenas no fluxo de aviso.
Observações
O valor padrão da 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ória, como "abc". A mensagem de erro resultante lista os valores válidos.
