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。

Note

情報ストリームは、メッセージの先頭に "[Stream Name]:" を付けることを標準の規則に従っていません。 これは簡潔で視覚的なクリーンを意図していました。

基本設定変数の値は $InformationPreference 、指定するメッセージ Write-Information がスクリプトの操作の予想されるポイントに表示されるかどうかを決定します。 この変数の既定値は SilentlyContinue であるため、既定では情報メッセージは表示されません。 値$InformationPreferenceを変更しない場合は、InformationAction 共通パラメーターをコマンドに追加して、その値をオーバーライドできます。 詳細については、「about_Preference_Variablesとabout_CommonParameters」を参照してください。

Note

Windows PowerShell 5.0 以降では、 Write-Host このラッパー Write-Information を使用 Write-Host して情報ストリームに出力を出力できます。 これにより、下位互換性を維持しながら、使用して Write-Host 書き込まれたデータのキャプチャまたは抑制が可能になります。 詳細については、書き込みホストを参照してください 。

例

例 1: Get- results の情報を書き込む

この例では、コマンドを実行Get-Processして、'p' で始まる Name 値を持つすべてのプロセスを検索する前に、"'P' で始まるプロセス" という情報メッセージを表示します。 変数は既定の $InformationPreference SilentlyContinue に設定されているため、InformationAction パラメーターを追加して値を$InformationPreferenceオーバーライドし、メッセージを表示します。 InformationAction 値は Continue です。つまり、メッセージが表示されますが、スクリプトまたはコマンドがまだ完了していない場合は続行されます。

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: ファイルに情報を書き込む

この例では、関数内の情報ストリームをコード6>を使用するようにInfo.txtリダイレクトします。 ファイルを Info.txt 開くと、"Here you go" というテキストが表示されます。

function Test-Info
{
    Get-Process P*
    Write-Information "Here you go"
}
Test-Info 6> Info.txt

例 4: 情報を書き込むオブジェクトを渡す

この例では、 Write-Information 複数のパイプラインを通過するオブジェクト出力から Get-Process 、上位 10 個の CPU 使用率プロセスを書き込むことができます。

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

スクリプトまたはコマンドを実行するときにユーザーに表示する情報メッセージを指定します。 最良の結果を得るには、情報メッセージを引用符で囲みます。

Type:Object
Aliases:Msg, Message
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Tags

情報ストリーム Write-Informationに追加したメッセージの並べ替えとフィルター処理に使用できる 1 つ以上の文字列。 このパラメーターは、次の Tags パラメーターと同様にNew-ModuleManifest機能します。

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

Object

オブジェクトをパイプして、このコマンドレットに情報ストリームに渡すことができます。

出力

None

このコマンドレットは、出力を返しません。 情報メッセージ ストリームにのみ書き込まれます。