Freigeben über


Write-Information

Gibt an, wie Windows PowerShell Informationsstromdaten für einen Befehl verarbeitet.

Syntax

Default (Standard)

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

Beschreibung

Das Write-Information Cmdlet gibt an, wie Windows PowerShell Informationsstromdaten für einen Befehl verarbeitet.

In Windows PowerShell 5.0 wird ein neuer, strukturierter Informationsstrom (Nummer 6 in Windows PowerShell-Datenströmen) eingeführt, den Sie zum Übertragen strukturierter Daten zwischen einem Skript und seinen Aufrufern (oder der Hostumgebung) verwenden können. Write-Information können Sie dem Datenstrom eine Informationsmeldung hinzufügen und angeben, wie Windows PowerShell Informationsstromdaten für einen Befehl verarbeitet. Informationsströme funktionieren auch für PowerShell.Streams, Jobs, geplante Jobs und Workflows.

Hinweis

Der Informationsstrom folgt nicht der Standardkonvention, seine Nachrichten mit dem Präfix "[Stream Name]:" zu versehen. Dies war für Kürze und visuelle Sauberkeit gedacht.

Der wert der einstellungsvariablen $InformationPreference bestimmt, ob die Nachricht, die Sie für Write-Information angeben, am erwarteten Punkt des Skriptvorgangs angezeigt wird. Da der Standardwert dieser Variablen SilentlyContinueist, werden standardmäßig keine Informationsmeldungen angezeigt. Wenn Sie den Wert von $InformationPreferencenicht ändern möchten, können Sie den Wert überschreiben, indem Sie dem Befehl den InformationAction Parameter common hinzufügen. Weitere Informationen finden Sie unter about_Preference_Variables und about_CommonParameters.

Hinweis

Ab Windows PowerShell 5.0 ist Write-Host ein Wrapper für Write-Information. Damit können Sie Write-Host zum Ausgeben der Ausgabe an den Informationsstrom verwenden. Dies ermöglicht die Erfassung oder Unterdrückung von Daten, die mithilfe von Write-Host geschrieben wurden, während die Abwärtskompatibilität beibehalten wird. Weitere Informationen finden Sie unter Write-Host

Write-Information ist auch eine unterstützte Workflow-Aktivität.

Beispiele

Beispiel 1: Informationen schreiben für "Get-results"

Get-WindowsFeature -Name p*; Write-Information -MessageData "Got your features!" -InformationAction Continue
Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
Got your features!

In diesem Beispiel zeigen Sie die Informationsmeldung "Sie haben Ihre Features!" an, nachdem Sie den Get-WindowsFeature Befehl ausgeführt haben, um alle Features zu suchen, deren Name-Wert mit "p" beginnt. Da die $InformationPreference Variable weiterhin auf den Standardwert festgelegt ist, SilentlyContinuefügen Sie den InformationAction Parameter hinzu, um den $InformationPreference Wert zu überschreiben und die Meldung anzuzeigen. Der InformationAction Wert ist Continue, was bedeutet, dass die Nachricht angezeigt wird, das Skript oder der Befehl jedoch fortgesetzt wird, wenn es noch nicht abgeschlossen ist.

Beispiel 2: Informationen schreiben und taggen

Get-WindowsFeature -Name p*; Write-Information -MessageData "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet." -Tags "Instructions" -InformationAction Continue
Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
To filter your results for PowerShell, pipe your results to the Where-Object cmdlet.

In diesem Beispiel verwenden Sie Write-Information, um Benutzern mitzuteilen, dass sie einen anderen Befehl ausführen müssen, nachdem sie den aktuellen Befehl ausgeführt haben. Im Beispiel wird der Informationsmeldung das Tag Instructions hinzugefügt. Wenn Sie nach dem Ausführen dieses Befehls den Informationsstrom nach Nachrichten durchsuchen, die mit Anweisungen gekennzeichnet sind, gehört die hier angegebene Nachricht zu den Ergebnissen.

Beispiel 3: Schreiben von Informationen in eine Datei

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

In diesem Beispiel leiten Sie den Informationsstrom in der Funktion mithilfe des Codes 6> Info.txtin eine Datei um. Wenn Sie die Datei Info.txt öffnen, wird der Text "Here you go" angezeigt.

Parameter

-MessageData

Gibt eine Informationsmeldung an, die Benutzern angezeigt werden soll, während sie ein Skript oder einen Befehl ausführen. Um optimale Ergebnisse zu erzielen, schließen Sie die Informationsmeldung in Anführungszeichen ein. Ein Beispiel ist "Test abgeschlossen".

Parametereigenschaften

Typ:Object
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Msg

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Tags

Gibt eine einfache Zeichenfolge an, die Sie zum Sortieren und Filtern von Nachrichten verwenden können, die Sie dem Informationsstrom mit Write-Informationhinzugefügt haben. Dieser Parameter funktioniert ähnlich wie der Tags-Parameter in New-ModuleManifest.

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Write-Information Akzeptiert keine weitergeleiteten Eingaben.

Ausgaben

InformationRecord