Write-Information
Určuje, jak PowerShell zpracovává údaje z informačního proudu pro příkaz.
Syntaxe
Write-Information
[-MessageData] <Object>
[[-Tags] <String[]>]
[<CommonParameters>]Description
Cmdlet Write-Information určuje, jak PowerShell zpracovává data informačního proudu pro příkaz.
Windows PowerShell 5.0 zavádí nový strukturovaný informační proud. Tento datový proud můžete použít k přenosu strukturovaných dat mezi skriptem a jeho volajícími nebo hostitelskou aplikací.
Write-Information umožňuje přidat do datového proudu informační zprávu a určit, jak PowerShell zpracovává data datového proudu informací pro příkaz. Informační streamy také fungují pro PowerShell.Streams, úlohy a naplánované úkoly.
Poznámka
Informační stream nedodržuje standardní konvenci předpony zpráv s názvem [Název streamu]:" To bylo určeno pro stručnost a vizuální čistotu.
Hodnota proměnné předvoleb $InformationPreference určuje, jestli se zpráva, kterou zadáte Write-Information, zobrazí v očekávaném bodě operace skriptu. Vzhledem k tomu, že výchozí hodnota této proměnné je SilentlyContinue, ve výchozím nastavení se informační zprávy nezobrazí.
Pokud nechcete změnit hodnotu $InformationPreference, můžete její hodnotu přepsat tak, že do příkazu přidáte InformationAction společný parametr. Další informace naleznete v tématu about_Preference_Variables a about_CommonParameters.
Poznámka
Počínaje Windows PowerShellem 5.0 je Write-Host obal pro Write-Information. To umožňuje použít Write-Host k vygenerování výstupu do informačního datového proudu. To umožňuje zachycení nebo potlačení dat zapsaných pomocí Write-Host při zachování zpětné kompatibility. Další informace naleznete v Write-Host
Write-Information je také podporovaná aktivita pracovního postupu ve Windows PowerShellu 5.1.
Příklady
Příklad 1: Zápis informací pro výsledky příkazu Get-
V tomto příkladu před spuštěním příkazu Get-Process zobrazíte informační zprávu "Procesy začínající písmenem P", abyste našli všechny procesy, které mají Název hodnotu začínající na "p".
Vzhledem k tomu, že proměnná $InformationPreference je stále nastavená na výchozí hodnotu, SilentlyContinue, přidáte parametr InformationAction, který přepíše hodnotu $InformationPreference a zobrazí zprávu. Hodnota InformationAction je Pokračovat, což znamená, že se vaše zpráva zobrazí, ale skript nebo příkaz pokračuje, pokud ještě není dokončený.
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 pwshPříklad 2: Zápis informací a označení
V tomto příkladu použijete Write-Information, abyste uživatelům dali vědět, že po spuštění aktuálního příkazu budou muset spustit další příkaz. Příklad přidá značku "Instructions" do informační zprávy. Po spuštění tohoto příkazu, když hledáte v informačním kanálu zprávy s označením "Instructions", zpráva se objeví ve výsledcích.
$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.Příklad 3: Zápis informací do souboru
V tomto příkladu přesměrujete datový proud informací ve funkci na Info.txt pomocí kódu 6>. Když otevřete soubor Info.txt, zobrazí se text "Tady to je".
function Test-Info
{
Get-Process P*
Write-Information "Here you go"
}
Test-Info 6> Info.txtPříklad 4: Ukládání záznamů informací do proměnné
Pomocí parametru InformationVariable můžete uložit záznamy informací do proměnné. Díky tomu můžete zkontrolovat zprávy informačního proudu později ve skriptu.
$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 : 10Parametry
-MessageData
Určuje informační zprávu, kterou chcete uživatelům zobrazit při spuštění skriptu nebo příkazu. Nejlepších výsledků dosáhnete uzavřením informační zprávy do uvozovek.
| Typ: | Object |
| Aliasy: | Msg |
| Position: | 0 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-Tags
Určuje jednoduchý řetězec, který můžete použít k řazení a filtrování zpráv, které jste přidali do informačního streamu pomocí Write-Information. Tento parametr funguje podobně jako parametr Tags v New-ModuleManifest.
| Typ: | String[] |
| Position: | 1 |
| Default value: | None |
| Vyžadováno: | False |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
Vstupy
None
Do této rutiny nemůžete předávat objekty.
Výstupy
None
Tento cmdlet nevrátí žádný výstup. Zapisuje se pouze do informačního streamu zpráv.
