PowerShell Genie

Write-Warning

Use Write-Warning to write a message to the warning stream, shown by default but kept out of your data.

Command 1 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — Write-Warning

Written and tested by Dhrub Bharali · Updated

Syntax

1PS> Write-Warning [-Message] <String> [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

Write-Warning [-Message] <String> [<CommonParameters>]
  1. Stage 1Write-Warning-Message

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Write with Write-Warning

    1PS> Write-Warning 'Skipped 3 unreachable machines'
    Show reference output

    Sample output · fictional data, shaped like the real thing

    WARNING: Skipped 3 unreachable machines

    Write-Warning -eq $r

    1PS> $r = Write-Warning 'not data'
    2PS> $null -eq $r
    Show reference output

    Sample output · fictional data, shaped like the real thing

    WARNING: not data

    Write with Write-Warning (2)

    1PS> Write-Warning 'Using default retry count of 3'
    Show reference output

    Sample output · fictional data, shaped like the real thing

    WARNING: Using default retry count of 3

    Parameters

    Parameter definitions:

    • -Message

    Write-Warning on Microsoft Learn

    Practical use and troubleshooting

    Practical scenario: Use Write-Warning when you need to write a message to the warning stream, shown by default but kept out of your data. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.

    Common error and fix: A warning being mistaken for failure can produce a misleading result. Decide whether the condition warrants an error and reserve Write-Warning for conditions where the operation can continue. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.

    See also: Write-Error. Write-Error records an error; Write-Warning records a warning. A warning does not automatically make a script fail, and a non-terminating error does not automatically enter catch. Read the linked command before substituting it; similar names do not imply identical inputs or output.

    Write-Warning reference on Microsoft Learn

    Recap

    Write-Warning Use Write-Warning to write a message to the warning stream, shown by default but kept out of your data.

    Next: Write-Debug
    Genie guideWrite-Warning

    Use Write-Warning to write a message to the warning stream, shown by default but kept out of your data. The console below is pre-loaded — run it, then change a value and run it again.

    Explore PowerShell Genie

    Related