Write-Information (Microsoft.PowerShell.Utility)

Write-Information

โมดูล :: Microsoft.PowerShell.Utility

ระบุวิธีที่ PowerShell จัดการข้อมูลสตรีมข้อมูลสำหรับคำสั่ง

ไวยากรณ์

Write-Information
     [-MessageData] <Object>
     [[-Tags] <String[]>]
     [<CommonParameters>]

คำอธิบาย

Write-Information cmdlet ระบุวิธีที่ PowerShell จัดการข้อมูลสตรีมข้อมูลสำหรับคำสั่ง

Windows PowerShell 5.0 แนะนำสตรีมข้อมูลที่มีโครงสร้างใหม่ คุณสามารถใช้สตรีมนี้เพื่อส่งข้อมูลที่มีโครงสร้างระหว่างสคริปต์และผู้เรียกหรือแอปพลิเคชันโฮสต์ เขียนข้อมูลช่วยให้คุณสามารถเพิ่มข้อความที่ให้ข้อมูลไปยังสตรีม และระบุวิธีที่ 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'" ก่อนที่จะรันคำสั่ง Get-Process เพื่อค้นหากระบวนการทั้งหมดที่มีค่า ชื่อ ที่ ขึ้นต้นด้วย 'p' เนื่องจากตัวแปร $InformationPreference ยังคงตั้งค่าเป็นค่าเริ่มต้น SilentlyContinue คุณจึงเพิ่มพารามิเตอร์ InformationAction เพื่อแทนที่ $InformationPreference value และแสดงข้อความ ค่า 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: เขียนข้อมูลและแท็ก

ในตัวอย่างนี้ คุณใช้ เขียนข้อมูล เพื่อให้ผู้ใช้ทราบว่าจะต้องเรียกใช้คำสั่งอื่นหลังจากที่เรียกใช้คำสั่งปัจจุบันเสร็จแล้ว ตัวอย่างเพิ่มแท็ก "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 เพื่อเขียนกระบวนการใช้งาน CPU สูงสุด 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

ระบุข้อความแสดงข้อมูลที่คุณต้องการแสดงต่อผู้ใช้ขณะที่รันสคริปต์หรือคำสั่ง เพื่อผลลัพธ์ที่ดีที่สุด ให้ใส่ข้อความแสดงข้อมูลไว้ในเครื่องหมายคำพูด

พิมพ์ :: วัตถุ
นามแฝง :: Msg, Message
ตำแหน่ง:: 0
ค่าเริ่มต้น:: None
ที่จำเป็น:: True
ยอมรับอินพุตไปป์ไลน์:: True
ยอมรับอักขระตัวแทน:: False

-Tags

สตริงตั้งแต่หนึ่งรายการขึ้นไปที่คุณสามารถใช้เพื่อจัดเรียงและกรองข้อความที่คุณเพิ่มลงในสตรีมข้อมูลด้วย Write-Information พารามิเตอร์นี้ทำงานคล้ายกับพารามิเตอร์ แท็ก ใน New-ModuleManifest

พิมพ์ :: String[]
ตำแหน่ง:: 1
ค่าเริ่มต้น:: None
ที่จำเป็น:: False
ยอมรับอินพุตไปป์ไลน์:: False
ยอมรับอักขระตัวแทน:: False

อินพุต

วัตถุ

คุณสามารถไปป์วัตถุเพื่อส่งผ่านไปยังสตรีมข้อมูลไปยัง cmdlet นี้

เอาท์พุต

ไม่มี

cmdlet นี้ส่งคืนไม่มีผลลัพธ์ มันเขียนเฉพาะสตรีมข้อความข้อมูลเท่านั้น

Write-Information (Microsoft.PowerShell.Utility)