Write-Information

指定 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_Variablesabout_CommonParameters

注意

从 Windows PowerShell 5.0 开始,这是一个包装器Write-InformationWrite-Host可用于Write-Host向信息流发出输出。 这样,便可以捕获或抑制使用 Write-Host 数据,同时保持向后兼容性。 有关详细信息,请参阅 Write-Host

示例

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

在此示例中,你将显示信息性消息“以'P'开头的进程”,然后运行 Get-Process 命令以查找具有以“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:将信息写入文件

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

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

示例 4:传递对象以写入信息

在此示例中,可以使用 Write-Information 它从 Get-Process 通过多个管道的对象输出写入前 10 个最高的 CPU 使用率进程。

Get-Process | Sort-Object CPU -Descending |
    Select-Object Id, ProcessName, CPU -First 10 |
        Write-Information -InformationAction Continue

@{Id=12692; ProcessName=chrome; CPU=39431.296875}
@{Id=21292; ProcessName=OUTLOOK; CPU=23991.875}
@{Id=10548; ProcessName=CefSharp.BrowserSubprocess; CPU=20546.203125}
@{Id=312848; ProcessName=Taskmgr; CPU=13173.1875}
@{Id=10848; ProcessName=SnapClient; CPU=7014.265625}
@{Id=9760; ProcessName=Receiver; CPU=6792.359375}
@{Id=12040; ProcessName=Teams; CPU=5605.578125}
@{Id=498388; ProcessName=chrome; CPU=3062.453125}
@{Id=6900; ProcessName=chrome; CPU=2546.9375}
@{Id=9044; ProcessName=explorer; CPU=2358.765625}

参数

-MessageData

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

Type:Object
Aliases:Msg, Message
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Tags

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

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

Object

Write-Information 接受传递给信息流的管道对象。

输出

InformationRecord