Write-Verbose

Writes text to the verbose message stream.
Write-Verbose [-Message*] <String> [<CommonParameters>]

The Write-Verbose cmdlet writes text to the verbose message stream in Windows PowerShell. Typically, the verbose message stream is used to deliver information about command processing that is used for debugging a command.

By default, the verbose message stream is not displayed, but you can display it by changing the value of the $VerbosePreference variable or using the Verbose common parameter in any command.

Parameters
-Message <String>

  • This value is required
  • Accepts pipeline input ByValue

Specifies the message to display. This parameter is required. You can also pipe a message string to Write-Verbose.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.String

You can pipe a string that contains the message to Write-Verbose.

Outputs

None

Write-Verbose writes only to the verbose message stream.

Examples
  1. Write a status message:
    PS C:> Write-Verbose -Message "Searching the Application Event Log."
    PS C:> Write-Verbose -Message "Searching the Application Event Log." -Verbose
    

    These commands use the Write-Verbose cmdlet to display a status message. By default, the message is not displayed.

    The second command uses the Verbose common parameter, which displays any verbose messages, regardless of the value of the $VerbosePreference variable.

  2. Set $VerbosePreference and write a status message:
    PS C:> $VerbosePreference = "Continue"
    PS C:> Write-Verbose "Copying file $filename"
    

    These commands use the Write-Verbose cmdlet to display a status message. By default, the message is not displayed.

    The first command assigns a value of Continue to the $VerbosePreference preference variable. The default value, SilentlyContinue, suppresses verbose messages. The second command writes a verbose message.

Additional Notes
 Verbose messages are returned only when the command uses the Verbose common parameter. For more information, 
 see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 In Windows PowerShell background jobs and remote commands, the $VerbosePreference variable in the job session 
 and remote session determine whether the verbose message is displayed by default. For more information about 
 the $VerbosePreference variable, see about_Preference_Variables 
 (http://go.microsoft.com/fwlink/?LinkID=113248).
Related Links

Write-Debug
Write-Error
Write-EventLog
Write-Host
Write-Information
Write-Output
Write-Progress
Write-Warning