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

Write-Information

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

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

Синтаксис

Default (По умолчанию) 

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

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

Примеры

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

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

С помощью параметра 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

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

Свойства параметров

Тип:Object
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:Msg

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Tags

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

Свойства параметров

Тип:

String[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

None

Невозможно передать объекты в этот командлет.

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

None

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