Es gibt keine Cmdlets, die sowohl Neulingen als auch Experten vertrauter sind als der PowerShell-Hilfebefehl Get-Help. Aufgrund des integrierten und aktualisierbaren Hilfe-Systems von PowerShell ist der PowerShell-Befehl Get-Help die Methode, um herauszufinden, was Befehle tun, ihre Parameter und hoffentlich viele nützliche Beispiele, wie der Befehl verwendet wird.
Jedes Cmdlet und jede Funktion, auf die Sie stoßen, sollen mit Hilfeinhalten versehen sein, die der PowerShell Get-Help-Befehl lesen kann. Ich sage „sollte“, weil leider einige Autoren keine Hilfeinhalte einfügen.
Hilfeinhalte, die mit Befehlen verbunden sind, können durch Ausführen von Get-Help gefunden werden. Dieser Befehl liest sowohl kommentarbasierte als auch XML-basierte Hilfe, die vom Cmdlet- oder Funktionsautor erstellt wurde.
Die häufigste Verwendung des Get-Help-Cmdlets besteht darin, es zu verwenden, um Hilfeinhalte für einen bestimmten Befehl zu finden. Zum Beispiel haben Sie vielleicht einen neuen Befehl namens Get-Content mit dem Get-Command-Cmdlet entdeckt und möchten mehr Informationen darüber wissen. Sie würden den Name-Parameter bei Get-Help verwenden. Dies würde eine grundlegende Menge an Informationen über diesen Befehl zurückgeben, wie Sie unten sehen können.
Sie werden feststellen, dass zwar viele Informationen zurückgegeben werden, es sich jedoch nur um eine Zusammenfassung der Dinge handelt, die Sie tun können. Und Sie würden nie wissen, dass Get-Help auch andere Arten von Hilfsinhalten zurückgeben kann, wie zum Beispiel Beispiele.
Parameterinformationen finden
Sie können sich auf verschiedene Arten tiefer in den Hilfsinhalt einarbeiten. Eine Möglichkeit besteht darin, Informationen zu einem einzelnen Parameter eines Befehls zu finden. Vielleicht sehe ich in dem Beispiel, das ich hier verwende, einen Verweis auf einen Raw-Parameter und bin mir nicht ganz sicher, was dieser Parameter bewirkt. Ich kann den Parameter-Parameter auf Get-Help mit dem Name-Parameter verwenden, um nur Informationen zu diesem bestimmten Befehlsparameter zurückzugeben.
PowerShell Get-Help und Beispiele
Eines der besten Dinge am PowerShell-Hilfesystem ist, dass es native Unterstützung für Beispiele bietet. Beispiele sind eine ausgezeichnete Möglichkeit, mit Kontext zu sehen, wie ein bestimmter Befehl verwendet wird. Wenn der Befehlsautor Beispiele zu seinem Hilfsinhalt hinzugefügt hat, können Sie diese Beispiele mithilfe des Examples-Parameters sehen. Wenn Sie diesen Parameter verwenden, gibt Get-Help ein oder mehrere Beispiele dafür zurück, wie dieser Befehl in verschiedenen Situationen verwendet wird.
Detaillierte Hilfe erhalten
Zusammenfassungen, Parameterinformationen und Beispiele sind nicht die einzigen Informationen, die der PowerShell-Get-Help-Befehl zurückgibt. Manchmal müssen Sie alle verfügbaren Informationen für ein Cmdlet sehen. In diesem Fall haben Sie immer die Detailed– und Full-Parameter zur Verfügung. Jeder dieser Parameter zeigt eine zunehmende Menge an Informationen an.
Der Parameter Detailed fügt Parameterbeschreibungen und Beispiele zur primären Hilfesanzeige hinzu. Im Wesentlichen kombinieren sie die Verwendung des Beispiele-Parameters und zeigen Informationen für alle Parameter an, als ob Sie den Parameter-Parameter für alle Befehlsparameter verwendet hätten.
Wenn der Detailed-Parameter nicht ausreicht, können Sie immer den nuklearen Ansatz wählen und alle Hilfinhalte mit dem Full-Parameter zurückgeben. Dieser Parameter filtert überhaupt keine Informationen. Der Full-Parameter liest alle Hilfinhalte, die für einen bestimmten Befehl definiert sind.
Graphische Darstellung
Wenn Sie eine grafischere Darstellung der Hilfe wünschen, können Sie auch den ShowWindow-Parameter verwenden. Dieser Parameter öffnet ein Fenster, das es Ihnen ermöglicht, die Hilfinhalte einfach zu durchsuchen und bestimmte Bereiche nur über die Schaltfläche Einstellungen anzuzeigen. Diese Ansicht ist hilfreich, wenn Sie wirklich in die Suche nach Hilfinhalten eintauchen möchten.
Zusammenfassung
Es gibt einige andere, weniger verbreitete Parameter, die Sie mit dem PowerShell-Get-Help-Befehl verwenden können. Wenn Sie mehr darüber erfahren möchten, wissen Sie, wie Sie Informationen zu diesen zusätzlichen Parametern finden, oder? Ja, Get-Help kann Hilfinhalte zu sich selbst finden.
Verwenden Sie den Get-Help-Befehl gewissenhaft, wenn Sie weitere Informationen zu PowerShell-Befehlen suchen. Es besteht wenig Bedarf, Google zu konsultieren, wenn Sie ein leistungsfähiges Hilfesystem und einen Befehl haben, um darauf zuzugreifen.