Write-Debug
Use Write-Debug to write a developer-facing message to the debug stream, hidden unless -Debug is passed.
Documentation: Microsoft Learn — Write-Debug
Syntax
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-Debug [-Message] <String> [<CommonParameters>]- Stage 1Write-Debug
-Message
Try it
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.
Follow the objects
Run the command to inspect each stage.
Examples
Write-Debug -Debug
Show reference output
Sample output · fictional data, shaped like the real thing
DEBUG: entering retry loop
Write with Write-Debug
Show reference output
Sample output · fictional data, shaped like the real thing
DEBUG: no prompt in 5.1 either
Write-Debug -Debug (2)
Show reference output
Sample output · fictional data, shaped like the real thing
DEBUG: count=3 target=WEB01
Parameters
Parameter definitions:
-Message
Practical use and troubleshooting
Practical scenario: Use Write-Debug when you need to write a developer-facing message to the debug stream, hidden unless -Debug is passed. 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: No visible debug message can reflect DebugPreference. Enable debugging deliberately for the relevant command and restore preferences afterwards rather than leaving an unattended script waiting for input. 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-Verbose. Write-Verbose provides optional operational detail; Write-Debug provides debugging detail. Their visibility is controlled separately and neither should be used as ordinary function return data. Read the linked command before substituting it; similar names do not imply identical inputs or output.
Recap
Write-Debug Use Write-Debug to write a developer-facing message to the debug stream, hidden unless -Debug is passed.
Next: Write-Verbose