Write-Information

参考

模块:: Microsoft.PowerShell.Utility

指定 PowerShell 如何处理命令的信息流数据。

语法

Write-Information
     [-MessageData] <Object>
     [[-Tags] <String[]>]
     [<CommonParameters>]

说明

Write-Information cmdlet 指定 PowerShell 如何处理命令的信息流数据。

Windows PowerShell 5.0 引入了新的结构化信息流。可以使用此流在脚本及其调用方或主机应用程序之间传输结构化数据。 Write-Information 允许向流添加信息性消息，并指定 PowerShell 如何处理命令的信息流数据。信息流也适用于 PowerShell.Streams、作业和计划任务。

注意

信息流不遵循使用“[流名称]：”作为消息前缀的标准约定。这是为了简洁和视觉清洁。

$InformationPreference 首选项变量值确定提供给 Write-Information 的消息是否显示在脚本操作的预期点。由于此变量的默认值 SilentlyContinue，因此默认情况下不显示信息性消息。如果不想更改 $InformationPreference的值，可以通过向命令添加 InformationAction 通用参数来替代其值。欲了解更多信息，请参阅 about_Preference_Variables 和 about_CommonParameters。

注意

从 Windows PowerShell 5.0 开始，Write-Host 是 Write-Information 的包装器。这允许你使用 Write-Host 向信息流发出输出。这样就可以捕获或抑制使用 Write-Host 写入的数据，同时保持向后兼容性。有关详细信息，请参阅 Write-Host

Write-Information 也是 Windows PowerShell 5.1 中支持的工作流活动。

示例

示例 1：为 Get- results 写入信息

在此示例中，你将在运行 Get-Process 命令之前显示信息性消息“以'P'开头的进程”，以查找具有以“p”开头名称值的所有进程。由于 $InformationPreference 变量仍设置为其默认值，SilentlyContinue，因此添加 InformationAction 参数以替代 $InformationPreference 值，并显示消息。 InformationAction 值是 Continue，这意味着会显示消息，但是脚本或命令会继续运行（如果尚未完成）。

Write-Information -MessageData "Processes starting with 'P'" -InformationAction Continue
Get-Process -Name p*

Processes starting with 'P'

     18    19.76      15.16       0.00    6232   0 PFERemediation
     20     8.92      25.15       0.00   24944   0 policyHost
      9     1.77       7.64       0.00    1780   0 powercfg
     10    26.67      32.18       0.00    7028   0 powercfg
      8    26.55      31.59       0.00   13600   0 powercfg
      9     1.66       7.55       0.00   22620   0 powercfg
     21     6.17       4.54     202.20   12536   1 PowerMgr
     42    84.26      12.71   2,488.84   20588   1 powershell
     27    47.07      45.38       2.05   25988   1 powershell
     27    24.45       5.31       0.00   12364   0 PresentationFontCache
     92   112.04      13.36      82.30   13176   1 pwsh
    106   163.73      93.21     302.25   14620   1 pwsh
    227   764.01      92.16   1,757.22   25328   1 pwsh

示例 2：编写信息并将其标记

在此示例中，使用 Write-Information 让用户知道在运行当前命令后，他们需要运行另一个命令。该示例将标记 "Instructions" 添加到信息性消息中。运行此命令后，在信息流中搜索标记为 "Instructions"的消息时，消息将位于结果中。

$message = "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet."
Get-Process -Name p*
Write-Information -MessageData $message -Tags "Instructions" -InformationAction Continue

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     18    19.76      15.16       0.00    6232   0 PFERemediation
     20     8.92      25.15       0.00   24944   0 policyHost
      9     1.77       7.64       0.00    1780   0 powercfg
     10    26.67      32.18       0.00    7028   0 powercfg
      8    26.55      31.59       0.00   13600   0 powercfg
      9     1.66       7.55       0.00   22620   0 powercfg
     21     6.17       4.54     202.20   12536   1 PowerMgr
     42    84.26      12.71   2,488.84   20588   1 powershell
     27    47.07      45.38       2.05   25988   1 powershell
     27    24.45       5.31       0.00   12364   0 PresentationFontCache
     92   112.04      13.36      82.30   13176   1 pwsh
    106   163.73      93.21     302.25   14620   1 pwsh
    227   764.01      92.16   1,757.22   25328   1 pwsh

To filter your results for PowerShell, pipe your results to the Where-Object cmdlet.

示例 3：将信息写入文件

在此示例中，将使用代码 6>将函数中的信息流重定向到 Info.txt。打开 Info.txt 文件时，你会看到文本“Here you go”。

function Test-Info
{
    Get-Process P*
    Write-Information "Here you go"
}
Test-Info 6> Info.txt

示例 4：将信息记录保存到变量

使用 InformationVariable 参数，可以将信息记录保存到变量。这样，就可以在脚本中稍后检查信息流消息。

$psproc = Get-Process -Id $PID | Select-Object ProcessName, CPU, Path
Write-Information -MessageData $psproc -Tags 'PowerShell' -InformationVariable 'InfoMsg'
$InfoMsg | Select-Object *

MessageData     : @{ProcessName=powershell; CPU=1.609375;
                  Path=C:\WINDOWS\System32\WindowsPowerShell\v1.0\powershell.exe}
Source          : Write-Information
TimeGenerated   : 10/19/2023 11:28:15
Tags            : {PowerShell}
User            : sdwheeler
Computer        : circumflex
ProcessId       : 237
NativeThreadId  : 261
ManagedThreadId : 10

参数

-MessageData

指定要在用户运行脚本或命令时向用户显示的信息性消息。为获得最佳结果，请将信息性消息括在引号中。

类型:	Object
别名:	Msg
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Tags

指定一个简单的字符串，可用于使用 Write-Information对已添加到信息流的消息进行排序和筛选。此参数的工作方式类似于 New-ModuleManifest中的 Tags 参数。

类型:	String[]
Position:	1
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出