Freigeben über

Get-Help

  • Referenz
Modul:
Microsoft.PowerShell.Core

Zeigt Informationen zu PowerShell-Befehlen und -Konzepten an.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Beschreibung

Das cmdlet Get-Help zeigt Informationen zu PowerShell-Konzepten und -Befehlen an, einschließlich Cmdlets, Funktionen, Common Information Model (CIM)-Befehlen, Workflows, Anbietern, Aliasen und Skripts.

Um Hilfe zu einem PowerShell-Cmdlet zu erhalten, geben Sie Get-Help gefolgt vom Cmdlet-Namen ein, z. B.: Get-Help Get-Process.

Konzeptionelle Hilfeartikel in PowerShell beginnen mit about_, z. B. about_Comparison_Operators. Wenn Sie alle about_ Artikel anzeigen möchten, geben Sie Get-Help about_*ein. Wenn Sie einen bestimmten Artikel anzeigen möchten, geben Sie Get-Help about_<article-name>ein, z. B. Get-Help about_Comparison_Operators.

Um Hilfe für einen PowerShell-Anbieter zu erhalten, geben Sie Get-Help gefolgt vom Anbieternamen ein. Um z. B. Hilfe für den Zertifikatanbieter zu erhalten, geben Sie Get-Help Certificateein.

Sie können auch help oder maneingeben, wodurch jeweils ein Textbildschirm angezeigt wird. Oder <cmdlet-name> -?, das mit Get-Helpidentisch ist, funktioniert jedoch nur für Cmdlets.

Get-Help ruft den Hilfeinhalt ab, der von Hilfedateien auf Ihrem Computer angezeigt wird. Ohne die Hilfedateien zeigt Get-Help nur grundlegende Informationen zu Cmdlets an. Einige PowerShell-Module enthalten Hilfedateien. Ab PowerShell 3.0 enthalten die Module, die im Windows-Betriebssystem enthalten sind, keine Hilfedateien. Um die Hilfedateien für ein Modul in PowerShell 3.0 herunterzuladen oder zu aktualisieren, verwenden Sie das cmdlet Update-Help.

Sie können die PowerShell-Hilfedokumente auch online in den Microsoft-Dokumenten anzeigen. Um die Onlineversion einer Hilfedatei abzurufen, verwenden Sie den Parameter Online, z. B.: Get-Help Get-Process -Online. Informationen zum Lesen aller PowerShell-Dokumentationen finden Sie in der Microsoft Docs PowerShell-Dokumentation.

Wenn Sie Get-Help gefolgt vom genauen Namen eines Hilfeartikels oder von einem für einen Hilfeartikel eindeutigen Wort eingeben, zeigt Get-Help den Inhalt des Artikels an. Wenn Sie den genauen Namen eines Befehlsalias angeben, zeigt Get-Help die Hilfe für den ursprünglichen Befehl an. Wenn Sie ein Wort- oder Wortmuster eingeben, das in mehreren Hilfeartikeltiteln angezeigt wird, zeigt Get-Help eine Liste der übereinstimmenden Titel an. Wenn Sie Text eingeben, der in keinem Hilfeartikeltitel angezeigt wird, zeigt Get-Help eine Liste von Artikeln an, die diesen Text in ihren Inhalt einschließen.

Get-Help können Hilfeartikel für alle unterstützten Sprachen und Gebietsschemas abrufen. Get-Help sucht zuerst nach Hilfedateien im Gebietsschema für Windows, dann im übergeordneten Gebietsschema, z. B. pt für pt-BRund dann in einem Fallbackgebietsschema. Ab PowerShell 3.0 sucht Get-Help, wenn Get-Help keine Hilfe im Fallbackgebietsschema findet, nach Hilfeartikeln in Englisch, en-US, bevor eine Fehlermeldung zurückgegeben oder automatisch generierte Hilfe angezeigt wird.

Informationen zu den Symbolen, die Get-Help im Befehlssyntaxdiagramm angezeigt werden, finden Sie unter about_Command_Syntax. Informationen zu Parameterattributen wie Required und Positionfinden Sie unter about_Parameters.

Anmerkung

In PowerShell 3.0 und PowerShell 4.0 kann Get-Help nicht Artikel zu In Modulen finden, es sei denn, das Modul wird in die aktuelle Sitzung importiert. Dies ist ein bekanntes Problem. Um Informationen zu Artikeln in einem Modul zu erhalten, importieren Sie das Modul entweder mithilfe des cmdlets Import-Module oder durch Ausführen eines Cmdlets, das im Modul enthalten ist.

Beispiele

Beispiel 1: Anzeigen grundlegender Hilfeinformationen zu einem Cmdlet

In diesen Beispielen werden grundlegende Hilfeinformationen zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> ist die einfachste und standardsyntax des Cmdlets Get-Help. Sie können den Parameter Name weglassen.

Die Syntax <cmdlet-name> -? funktioniert nur für Cmdlets.

Beispiel 2: Gleichzeitiges Anzeigen grundlegender Informationen auf einer Seite

In diesen Beispielen werden grundlegende Hilfeinformationen zum cmdlet Format-Table jeweils jeweils auf einer Seite angezeigt.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help ist eine Funktion, die intern Get-Help Cmdlet ausführt und das Ergebnis jeweils eine Seite anzeigt.

man ist ein Alias für die help-Funktion.

Get-Help Format-Table sendet das Objekt an die Pipeline. Out-Host -Paging empfängt die Ausgabe der Pipeline und zeigt sie jeweils auf einer Seite an. Weitere Informationen finden Sie unter Out-Host-.

Beispiel 3: Anzeigen weiterer Informationen für ein Cmdlet

In diesen Beispielen werden ausführlichere Hilfeinformationen zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Der parameter "Detaillierte" zeigt die detaillierte Ansicht des Hilfeartikels an, die Parameterbeschreibungen und Beispiele enthält.

Der Full-Parameter zeigt die vollständige Ansicht des Hilfeartikels an, die Parameterbeschreibungen, Beispiele, Eingabe- und Ausgabeobjekttypen und zusätzliche Hinweise enthält.

Die Parameter "Detaillierte" und "Full" sind nur für die Befehle gültig, die Hilfedateien auf dem Computer installiert haben. Die Parameter sind für die konzeptionellen (about_) Hilfeartikel nicht wirksam.

Beispiel 4: Anzeigen ausgewählter Teile eines Cmdlets mithilfe von Parametern

In diesen Beispielen werden ausgewählte Teile der Hilfe zum Cmdlet Format-Table angezeigt.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Im parameter Examples werden die NAME der Hilfedatei und SYNOPSIS Abschnitte sowie alle Beispiele angezeigt. Sie können keine Beispielnummer angeben, da Examples Parameter ein Switch-Parameter ist.

Der Parameter Parameter zeigt nur die Beschreibungen der angegebenen Parameter an. Wenn Sie nur das Sternchen (*) als Wildcardzeichen angeben, werden die Beschreibungen aller Parameter angezeigt. Wenn Parameter einen Parameternamen wie GroupByangibt, werden Informationen zu diesem Parameter angezeigt.

Diese Parameter sind für die konzeptionellen (about_) Hilfeartikel nicht wirksam.

Beispiel 5: Anzeigen der Onlineversion der Hilfe

In diesem Beispiel wird die Onlineversion des Hilfeartikels für das Cmdlet Format-Table in Ihrem Standardwebbrowser angezeigt.

Get-Help Format-Table -Online

Beispiel 6: Anzeigen von Hilfe zum Hilfesystem

Das Cmdlet Get-Help ohne Parameter zeigt Informationen zum PowerShell-Hilfesystem an.

Get-Help

Beispiel 7: Anzeigen verfügbarer Hilfeartikel

In diesem Beispiel wird eine Liste aller auf Ihrem Computer verfügbaren Hilfeartikel angezeigt.

Get-Help *

Beispiel 8: Anzeigen einer Liste von konzeptuellen Artikeln

In diesem Beispiel wird eine Liste der konzeptionellen Artikel angezeigt, die in der PowerShell-Hilfe enthalten sind. Alle diese Artikel beginnen mit den Zeichen about_. Um eine bestimmte Hilfedatei anzuzeigen, geben Sie Get-Help \<about_article-name\>ein, z. B. Get-Help about_Signing.

Es werden nur die konzeptionellen Artikel mit hilfedateien angezeigt, die auf Ihrem Computer installiert sind. Informationen zum Herunterladen und Installieren von Hilfedateien in PowerShell 3.0 finden Sie unter Update-Help-.

Get-Help about_*

Beispiel 9: Suchen nach einem Wort in der Cmdlet-Hilfe

In diesem Beispiel wird gezeigt, wie Sie in einem Cmdlet-Hilfeartikel nach einem Wort suchen.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help verwendet den Parameter Full, um Hilfeinformationen für Add-Memberabzurufen. Das MamlCommandHelpInfo--Objekt wird an die Pipeline gesendet. Out-String verwendet den parameter Stream, um das Objekt in eine Zeichenfolge zu konvertieren. Select-String verwendet den Parameter Pattern, um die Zeichenfolge nach Clixml-zu durchsuchen.

Beispiel 10: Anzeigen einer Liste von Artikeln, die ein Wort enthalten

In diesem Beispiel wird eine Liste von Artikeln angezeigt, die das Wort Remotingenthalten.

Wenn Sie ein Wort eingeben, das in keinem Artikeltitel angezeigt wird, zeigt Get-Help eine Liste von Artikeln an, die dieses Wort enthalten.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Beispiel 11: Anbieterspezifische Hilfe anzeigen

In diesem Beispiel werden zwei Möglichkeiten zum Abrufen der anbieterspezifischen Hilfe für Get-Itemgezeigt. Diese Befehle erhalten Hilfe, die erläutert, wie Sie das cmdlet Get-Item im DataCollection-Knoten des PowerShell SQL Server-Anbieters verwenden.

Im ersten Beispiel wird der parameter Get-HelpPath verwendet, um den Pfad des SQL Server-Anbieters anzugeben. Da der Pfad des Anbieters angegeben ist, können Sie den Befehl von einem beliebigen Pfadspeicherort aus ausführen.

Im zweiten Beispiel wird Set-Location verwendet, um zum Pfad des SQL Server-Anbieters zu navigieren. Von diesem Speicherort aus ist der Path Parameter nicht erforderlich, damit Get-Help die anbieterspezifische Hilfe abrufen kann.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Beispiel 12: Anzeigen der Hilfe für ein Skript

In diesem Beispiel wird Hilfe für die MyScript.ps1 scriptangezeigt. Informationen zum Schreiben von Hilfe zu Ihren Funktionen und Skripts finden Sie unter about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parameter

-Category

Zeigt hilfe nur für Elemente in der angegebenen Kategorie und deren Aliase an. Konzeptionelle Artikel befinden sich in der Kategorie HelpFile-.

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • Alias
  • Cmdlet
  • Anbieter
  • Allgemein
  • Häufig gestellte Fragen
  • Glossar
  • HelpFile
  • ScriptCommand
  • Funktion
  • Filter
  • ExternalScript
  • Alle
  • DefaultHelp
  • Arbeitsablauf
  • DscResource
  • Klasse
  • Konfiguration
Typ:String[]
Zulässige Werte:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Component

Zeigt Befehle mit dem angegebenen Komponentenwert an, z. B. Exchange-. Geben Sie einen Komponentennamen ein. Wildcardzeichen sind zulässig. Dieser Parameter wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Detailed

Fügt der grundlegenden Hilfeanzeige Parameterbeschreibungen und Beispiele hinzu. Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Sie wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Examples

Zeigt nur den Namen, die Veröffentlichungen und Beispiele an. Geben Sie (Get-Help \<cmdlet-name\>).Examplesein, um nur die Beispiele anzuzeigen.

Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Sie wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Full

Zeigt den gesamten Hilfeartikel für ein Cmdlet an. Full enthält Parameterbeschreibungen und Attribute, Beispiele, Eingabe- und Ausgabeobjekttypen und zusätzliche Hinweise.

Dieser Parameter ist nur wirksam, wenn die Hilfedateien auf dem Computer installiert sind. Sie wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Functionality

Zeigt Hilfe für Elemente mit der angegebenen Funktionalität an. Geben Sie die Funktionalität ein. Wildcardzeichen sind zulässig. Dieser Parameter wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Name

Ruft Hilfe zum angegebenen Befehl oder Konzept ab. Geben Sie den Namen eines Cmdlets, einer Funktion, eines Anbieters, eines Skripts oder eines Workflows ein, z. B. Get-Member, einen konzeptuellen Artikelnamen, z. B. about_Objectsoder einen Alias, z. B. ls. Wildcardzeichen sind in Cmdlet- und Anbieternamen zulässig, aber Sie können keine Wildcardzeichen verwenden, um die Namen der Funktionshilfe- und Skripthilfeartikel zu finden.

Um Hilfe für ein Skript zu erhalten, das sich nicht in einem Pfad befindet, der in der umgebungsvariablen $env:Path aufgeführt ist, geben Sie den Pfad und dateinamen des Skripts ein.

Wenn Sie den genauen Namen eines Hilfeartikels eingeben, zeigt Get-Help den Artikelinhalt an.

Wenn Sie ein Wort- oder Wortmuster eingeben, das in mehreren Hilfeartikeltiteln angezeigt wird, zeigt Get-Help eine Liste der übereinstimmenden Titel an.

Wenn Sie Text eingeben, der keinem Hilfeartikeltitel entspricht, zeigt Get-Help eine Liste von Artikeln an, die diesen Text in ihren Inhalt einschließen.

Die Namen konzeptioneller Artikel, z. B. about_Objects, müssen in Englisch eingegeben werden, auch in nicht-englischen Versionen von PowerShell.

Typ:String
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Online

Zeigt die Onlineversion eines Hilfeartikels im Standardbrowser an. Dieser Parameter ist nur für Hilfeartikel zu Cmdlet, Funktion, Workflow und Skript gültig. Sie können den parameter Online nicht mit Get-Help in einer Remotesitzung verwenden.

Informationen zum Unterstützen dieses Features in Hilfeartikeln, die Sie schreiben, finden Sie unter about_Comment_Based_Helpund Unterstützende Onlinehilfeund Schreiben der Hilfe für PowerShell-Cmdlets.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Parameter

Zeigt nur die detaillierten Beschreibungen der angegebenen Parameter an. Wildcards sind zulässig. Dieser Parameter wirkt sich nicht auf die Anzeige konzeptioneller (About_) Hilfe aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Path

Ruft Hilfe ab, die erläutert, wie das Cmdlet im angegebenen Anbieterpfad funktioniert. Geben Sie einen PowerShell-Anbieterpfad ein.

Dieser Parameter ruft eine angepasste Version eines Cmdlet-Hilfeartikels ab, in dem erläutert wird, wie das Cmdlet im angegebenen PowerShell-Anbieterpfad funktioniert. Dieser Parameter ist nur für Hilfe zu einem Anbieter-Cmdlet gültig und nur, wenn der Anbieter eine benutzerdefinierte Version des Hilfeartikels des Anbieter-Cmdlets in der Hilfedatei enthält. Um diesen Parameter zu verwenden, installieren Sie die Hilfedatei für das Modul, das den Anbieter enthält.

Um die benutzerdefinierte Cmdlet-Hilfe für einen Anbieterpfad anzuzeigen, wechseln Sie zum Pfadspeicherort des Anbieters, und geben Sie einen Get-Help-Befehl ein, oder verwenden Sie den Path-Parameter von Get-Help, um den Anbieterpfad anzugeben. Sie finden auch die Hilfe zu benutzerdefinierten Cmdlets online im Hilfeabschnitt des Anbieters der Hilfeartikel.

Weitere Informationen zu PowerShell-Anbietern finden Sie unter about_Providers.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Role

Zeigt die für die angegebene Benutzerrolle angepasste Hilfe an. Geben Sie eine Rolle ein. Wildcardzeichen sind zulässig.

Geben Sie die Rolle ein, die der Benutzer in einer Organisation spielt. Einige Cmdlets zeigen je nach Wert dieses Parameters unterschiedliche Text in ihren Hilfedateien an. Dieser Parameter hat keine Auswirkungen auf die Hilfe für die kernen Cmdlets.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-ShowWindow

Zeigt das Hilfethema in einem Fenster an, um das Lesen zu erleichtern. Das Fenster enthält eine Suchfunktion Suchen und ein Einstellungen Feld, mit dem Sie Optionen für die Anzeige festlegen können, einschließlich Optionen zum Anzeigen nur ausgewählter Abschnitte eines Hilfethemas.

Der ShowWindow Parameter unterstützt Hilfethemen für Befehle (Cmdlets, Funktionen, CIM-Befehle, Skripts) und konzeptionelle Informationen zu Artikeln. Die Hilfe des Anbieters wird nicht unterstützt.

Dieser Parameter wurde in PowerShell 7.0 erneut eingeführt.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Objekte können nicht an Get-Helpgesendet werden.

Ausgaben

ExtendedCmdletHelpInfo

Wenn Sie Get-Help für einen Befehl ausführen, der keine Hilfedatei enthält, gibt Get-Help ein ExtendedCmdletHelpInfo-Objekt zurück, das automatisch generierte Hilfe darstellt.

String

Wenn Sie einen konzeptionellen Hilfeartikel erhalten, gibt Get-Help ihn als Zeichenfolge zurück.

MamlCommandHelpInfo

Wenn Sie einen Befehl mit einer Hilfedatei erhalten, gibt Get-Help ein MamlCommandHelpInfo-Objekt zurück.

Hinweise

PowerShell 3.0 enthält keine Hilfedateien. Verwenden Sie das Cmdlet Update-Help, um die Hilfedateien herunterzuladen und zu installieren, die gelesen Get-Help werden Update-Help. Sie können das Cmdlet Update-Help verwenden, um Hilfedateien für die wichtigsten Befehle herunterzuladen und zu installieren, die in PowerShell enthalten sind, sowie für alle Module, die Sie installieren. Sie können sie auch verwenden, um die Hilfedateien zu aktualisieren, damit die Hilfe auf Ihrem Computer niemals veraltet ist.

Sie können auch die Hilfeartikel zu den Befehlen lesen, die mit PowerShell online verfügbar sind, beginnend mit Erste Schritte mit Windows PowerShell.

Get-Help zeigt Hilfe im Gebietsschema für das Windows-Betriebssystem oder in der Fallbacksprache für dieses Gebietsschema an. Wenn Sie keine Hilfedateien für das primäre oder Fallbackgebietsschema haben, verhält sich Get-Help so, als ob keine Hilfedateien auf dem Computer vorhanden sind. Um Hilfe zu einem anderen Gebietsschema zu erhalten, verwenden Sie Region und Sprache in der Systemsteuerung, um die Einstellungen zu ändern. Unter Windows 10 oder höher Einstellungen, Zeit & Sprache.

Die vollständige Ansicht der Hilfe enthält eine Tabelle mit Informationen zu den Parametern. Die Tabelle enthält die folgenden Felder:

  • Erforderlich. Gibt an, ob der Parameter erforderlich ist (true) oder optional (false).

  • Position. Gibt an, ob der Parameter benannt oder positional (numerisch) ist. Positionsparameter müssen an einer angegebenen Stelle im Befehl angezeigt werden.

  • Benannte gibt an, dass der Parametername erforderlich ist, der Parameter kann jedoch an einer beliebigen Stelle im Befehl angezeigt werden.

  • Numerische gibt an, dass der Parametername optional ist, aber wenn der Name weggelassen wird, muss der Parameter an der durch die Zahl angegebenen Stelle sein. Beispielsweise gibt 2 an, dass der Parametername beim Weglassen des Parameters der zweite oder nur unbenannte Parameter im Befehl sein muss. Wenn der Parametername verwendet wird, kann der Parameter an einer beliebigen Stelle im Befehl angezeigt werden.

  • Standardwert. Der Parameterwert oder das Standardverhalten, das PowerShell verwendet, wenn Sie den Parameter nicht in den Befehl einschließen.

  • Akzeptiert Pipelineeingaben. Gibt an, ob Objekte über eine Pipeline an den Parameter gesendet werden können (true) oder nicht (false). By Property Name bedeutet, dass das weitergeleitete Objekt eine Eigenschaft aufweisen muss, die denselben Namen wie der Parametername hat.

  • Akzeptiertmit Wildcardzeichen. Gibt an, ob der Wert eines Parameters Platzhalterzeichen enthalten kann, z. B. ein Sternchen (*) oder Fragezeichen (?).