Write-Information
Указывает, как PowerShell обрабатывает данные потока информации для команды.
Синтаксис
Write-Information
[-MessageData] <Object>
[[-Tags] <String[]>]
[<CommonParameters>]
Описание
Командлет Write-Information
указывает, как 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-Information
Также поддерживается действие рабочего процесса в Windows PowerShell 5.1.
Примеры
Пример 1. Запись сведений для получения результатов
В этом примере отображается информационное сообщение "Процессы, начинающиеся с "P", перед выполнением Get-Process
команды, чтобы найти все процессы со значением "Имя ", начинающееся с "p".
$InformationPreference
Так как переменная по-прежнему имеет значение по умолчанию, SilentlyContinue добавляется параметр InformationAction для переопределения $InformationPreference
значения и отображения сообщения. Значение InformationAction — "Продолжить", что означает, что отображается сообщение, но скрипт или команда продолжается, если сообщение еще не завершено.
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. Сохранение записей сведений в переменную
Используя параметр 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
Указывает информационное сообщение, которое необходимо отобразить пользователям при выполнении скрипта или команды. Для получения наилучших результатов заключите информационное сообщение в кавычки.
Type: | Object |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
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 |
Входные данные
None
Невозможно передать объекты в этот командлет.
Выходные данные
None
Этот командлет не возвращает выходные данные. Он записывает только в поток информационных сообщений.
Связанные ссылки
PowerShell
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по