Write-Information (Microsoft.PowerShell.Utility)

Write-Information

Модуль:: Microsoft.PowerShell.Utility

Указывает, как PowerShell обрабатывает данные информационного потока для команды.

Синтаксис

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

Описание

Командлет Write-Information определяет, как PowerShell обрабатывает данные потока информации для команды.

Windows PowerShell 5.0 представляет новый структурированный информационный поток. Этот поток можно использовать для передачи структурированных данных между сценарием и его вызывающими объектами или хост-приложением. Write-Information позволяет добавить в поток информационное сообщение и указать, как PowerShell обрабатывает данные информационного потока для команды. Информационные потоки также работают для PowerShell.Streams, заданий и запланированных задач.

Примечание

Информационный поток не соответствует стандартному соглашению о добавлении к сообщениям префикса «[Имя потока]:». Это было сделано для краткости и визуальной чистоты.

Значение привилегированной переменной $InformationPreference определяет, будет ли сообщение, предоставленное вами Write-Information, отображаться в ожидаемой точке работы скрипта. Поскольку значением по умолчанию для этой переменной является SillyContinue, по умолчанию информационные сообщения не отображаются. Если вы не хотите изменять значение $InformationPreference, вы можете переопределить его значение, добавив в команду общий параметр InformationAction. Дополнительные сведения см. в разделах about_Preference_Variables и about_CommonParameters.

Примечание

Начиная с Windows PowerShell 5.0, Write-Host является оболочкой для Write-Information. Это позволяет использовать Write-Host для отправки вывода в информационный поток. Это позволяет захватывать или подавлять данные, записанные с помощью Write-Host, сохраняя при этом обратную совместимость. Для получения дополнительной информации см. Write-Host.

Примеры

Пример 1. Запись информации для Get-results.

В этом примере вы показываете информационное сообщение «Процессы, начинающиеся с 'P'» перед запуском команды Get-Process, чтобы найти все процессы, имеющие значение Name, которое начинается с буквы «п». Поскольку для переменной $InformationPreference по-прежнему установлено значение по умолчанию, SillyContinue, вы добавляете параметр 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, чтобы сообщить пользователям, что им нужно будет запустить другую команду после того, как они завершат выполнение текущей команды. В примере к информационному сообщению добавляется тег "Инструкции". После выполнения этой команды при поиске в информационном потоке сообщений с тегом "Инструкции" это сообщение появляется в результатах.

$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}

Пример 5: Сохранение информационных записей в переменную

Используя параметр InformationVariable, вы можете сохранять информационные записи в переменную. Это позволит вам проверять сообщения информационного потока позже в сценарии.

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

MessageData     : @{ProcessName=pwsh; CPU=12.36; Path=/opt/microsoft/powershell/7/pwsh}
Source          : Write-Information
TimeGenerated   : 10/19/2023 11:28:15
Tags            : {PowerShell}
User            : sdwheeler
Computer        : circumflex
ProcessId       : 237
NativeThreadId  : 261
ManagedThreadId : 10

Параметры

-MessageData

Указывает информационное сообщение, которое вы хотите отображать пользователям при запуске сценария или команды. Для достижения наилучших результатов заключите информационное сообщение в кавычки.

Тип :: Объект
Псевдонимы:: Msg, Message
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-Tags

Одна или несколько строк, которые можно использовать для сортировки и фильтрации сообщений, добавленных в информационный поток с помощью Write-Information. Этот параметр работает аналогично параметру Tags в New-ModuleManifest.

Тип :: String[]
Позиция:: 1
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

Объект

Вы можете передать объекты в информационный поток этому командлету.

Выходы

Нет

Этот командлет не возвращает никаких результатов. Он записывает только в поток информационных сообщений.