Поделиться через

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 в ожидаемой точке операции скрипта. Так как значение по умолчанию этой переменной SilentlyContinueпо умолчанию информационные сообщения не отображаются. Если вы не хотите изменить значение $InformationPreference, можно переопределить его значение, добавив в команду InformationAction общий параметр. Для получения дополнительной информации смотрите about_Preference_Variables и about_CommonParameters.

Заметка

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

Примеры

Пример 1. Написание информации для получения результатов

В этом примере отображается информационное сообщение "Процессы, начинающиеся с "P", перед выполнением команды для поиска всех процессов, имеющих значение имени , начинающееся с "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. Передача объекта для записи сведений

В этом примере можно использовать 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

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

Тип:Object
Aliases:Msg, Message
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Tags

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

Тип:String[]
Position:1
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

Object

Объекты можно передать в поток сведений в этот командлет.

Выходные данные

None

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