Write-Information
Указывает, как PowerShell обрабатывает данные потока информации для команды.
Синтаксис
Write-Information
[-MessageData] <Object>
[[-Tags] <String[]>]
[<CommonParameters>]
Описание
Командлет Write-Information
указывает, как PowerShell обрабатывает данные потока информации для команды.
Windows PowerShell 5.0 представляет новый структурированный информационный поток. Этот поток можно использовать для передачи структурированных данных между скриптом и его вызывающими элементами или ведущим приложением.
Write-Information
позволяет добавить информационное сообщение в поток и указать, как PowerShell обрабатывает данные потока информации для команды. Информационные потоки также работают для PowerShell.Streams
задач , заданий и запланированных задач.
Примечание
Поток информации не соответствует стандартному соглашению о префиксе своих сообщений с помощью "[имя Stream]:". Это было предназначено для краткости и визуальной чистоты.
Значение $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
Примеры
Пример 1. Запись сведений для получения результатов
В этом примере перед выполнением Get-Process
команды отображается информационное сообщение "Процессы, начинающиеся с "P", чтобы найти все процессы со значением Name , начинающимся с "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
записи 10 самых высоких процессов использования ЦП из Get-Process
выходных данных объекта, проходящих через несколько конвейеров.
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
помощью . Этот параметр работает аналогично параметру Tags в New-ModuleManifest
.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Write-Information
принимает переданные объекты для передачи в информационный поток.