次の方法で共有

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 を使用して書き込まれたデータのキャプチャまたは抑制が可能になります。 詳細については、「 Write-Host」を参照してください。

Write-Information は、Windows PowerShell 5.1 でサポートされているワークフロー アクティビティでもあります。

例

例 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: 情報レコードを変数に保管する

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
Aliases:Msg
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Tags

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

型:String[]
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

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