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задач , заданий и запланированных задач.

Примечание

Поток информации не соответствует стандартному соглашению о префиксе своих сообщений с помощью "[имя 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

Write-Information также является поддерживаемым действием рабочего процесса в PowerShell 5.x.

Примеры

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

В этом примере после выполнения Get-WindowsFeature команды показано информационное сообщение "У вас есть функции!", чтобы найти все функции, имеющие значение Name, начинающееся с "p". $InformationPreference Так как переменная по-прежнему имеет значение по умолчанию, SilentlyContinueдобавьте InformationAction параметр , чтобы переопределить $InformationPreference значение и отобразить сообщение. Значение InformationAction — Continue, что означает, что сообщение отображается, но сценарий или команда продолжается, если оно еще не завершено.

Get-WindowsFeature -Name p*
Write-Information -MessageData "Got your features!" -InformationAction Continue

Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
Got your features!

Пример 2. Запись сведений и добавление тегов к ним

В этом примере вы используете Write-Information , чтобы сообщить пользователям, что им потребуется выполнить другую команду после завершения выполнения текущей команды. В этом примере к информационному сообщению добавляется тег Instructions. После выполнения этой команды при поиске сообщений с тегом Instructions в потоке информации указанное здесь сообщение будет среди результатов.

$message = "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet."
Get-WindowsFeature -Name p*
Write-Information -MessageData $message -Tags "Instructions" -InformationAction Continue

Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
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

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

Object

Write-Information принимает переданные объекты для передачи в информационный поток.

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

InformationRecord