Beschreibt die in der Hilfe für Windows PowerShell-Syntax (about_Command_Syntax)
THEMAabout_Command_SyntaxKURZBESCHREIBUNGBeschreibt die in der Hilfe für Windows PowerShell-Syntax verwendete Notation.DETAILBESCHREIBUNGMit dem Cmdlet "Get-Help" wird die Parameterverwendung für ein Cmdlet angezeigt. Vom Cmdlet "Get-Help" werden die folgenden speziellen Symbole verwendet: Mit spitzen Klammern (<>) wird Platzhaltertext angegeben. Mit eckigen Klammern ([]) werden optionale Elemente angegeben. Mit geschweiften Klammern ({}) wird eine Werteauswahl angegeben. Einige Cmdlets verfügen über mehrere Parametersätze. Einige Parametersätze können gemeinsame Parameter enthalten. Im Cmdlet "Get-Help" werden alle Parametersätze für ein Cmdlet angezeigt. Weitere Informationen zu einem Parameter finden Sie in der Parameterbeschreibung sowie in der Parameterattributtabelle. Wenn Sie sämtliche Informationen zu einem Parameter anzeigen möchten, verwenden Sie den Full-Parameter bzw. den Parameter-Parameter von "Get-Help". Syntax In der Windows PowerShell-Hilfe, den Hilfethemen und der sonstigen Dokumentation zu Cmdlets wird die folgende Notation für Cmdlets in Syntaxbeschreibungen verwendet. <Cmdlet-Name> - <Erforderlicher Parametername> <Erforderlicher Parameterwert> [-<Optionaler Parametername> <Optionaler Parameterwert>] [-<Optionaler Schalterparameter>] [-<Optionaler Parametername>] <Erforderlicher Parameterwert> Im Folgenden ist die Syntax für das Cmdlet "New-Alias" dargestellt. New-Alias [-Force] [-PassThru] [-Scope <string>] [-Option {None | ReadOnly | Constant | Private | AllScope}] [-Description <string>] [-Name] <string> [-Value] <string> [-confirm] [-whatif] [<CommonParameters>] Die Syntax wird zur besseren Lesbarkeit großgeschrieben, bei Windows PowerShell ist die Groß- und Kleinschreibung jedoch irrelevant. Parameter werden in der entsprechenden Reihenfolge angezeigt. Die Reihenfolge der Parameter ist nur relevant, wenn die Parameternamen optional sind. Wenn Sie bei der Verwendung eines Cmdlets keine Parameternamen angeben, werden Parametern in Windows PowerShell Werte entsprechend der Position und dem Typ zugewiesen. Parameternamen wird ein Bindestrich (-) vorangestellt. Schalterparameter werden ohne Werttyp angezeigt. Sonstige Parameter werden mit dem Microsoft .NET Framework-Typ des erforderlichen Arguments oder mit einer Aufzählung der möglichen Werte angezeigt. Weitere Informationen zu .NET Framework-Typen finden Sie unter "http://go.microsoft.com/fwlink /?LinkId=143682" (möglicherweise auf Englisch). Mit spitzen Klammern (<>) wird Platzhaltertext angegeben. In diesem Text kann der Typ eines Elements beschrieben werden (z. B. eine Zeichenfolge oder ein Process-Objekt). Dabei kann es sich auch um einen Platzhalter für einen oder mehrere allgemeine Parameter handeln. Mit eckigen Klammern ([]) werden optionale Elemente angegeben. Ein Parameter kann optional sein, oder der Name eines erforderlichen Parameters kann optional sein. Schalterparameter sind immer optional. Die Werte einer Aufzählung sind in geschweifte Klammern ({}) eingeschlossen. Im Beispiel für das Cmdlet "New-Alias" kann der Option-Parameter beliebige der aufgelisteten Werte aufweisen. Optionale Elemente Optionale Elemente sind in eckige Klammern ([]) eingeschlossen. In der Syntaxbeschreibung zum Cmdlet "New-Alias" ist beispielsweise der Scope-Parameter optional. Dies wird in der Syntax durch die eckigen Klammern um den Parameternamen und den Typ kenntlich gemacht: [-Scope <string>] In den beiden folgenden Beispielen wird die korrekte Verwendung des Cmdlets "New-Alias" veranschaulicht: New-Alias -Name utd -Value Update-TypeData New-Alias -Name utd -Value Update-TypeData -Scope global Ein Parametername kann optional sein, selbst wenn der Wert des betreffenden Parameters erforderlich ist. Dies wird in der Syntax durch die eckigen Klammern um den Parameternamen angegeben, die jedoch nicht den Parametertyp einschließen, wie im folgenden Beispiel zum Cmdlet "New-Alias" veranschaulicht: [-Name] <string> [-Value] <string> In den folgenden Befehlen wird das Cmdlet "New-Alias" ordnungsgemäß verwendet. Die Befehle liefern dasselbe Ergebnis: New-Alias -Name utd -Value Update-TypeData New-Alias -Name utd Update-TypeData New-Alias utd -Value Update-TypeData New-Alias utd Update-TypeData Wenn der Parametername nicht wie eingegeben in der Anweisung enthalten ist, wird von Windows PowerShell versucht, die Werte anhand der Position der Argumente den Parametern zuzuweisen. Das folgende Beispiel ist nicht vollständig: New-Alias utd Von diesem Cmdlet werden Werte für den Name-Parameter und den Value-Parameter gefordert. In Syntaxbeispielen werden eckige Klammern auch für die Benennung und die Umwandlung in .NET Framework-Typen verwendet. In diesem Zusammenhang weisen eckige Klammern nicht darauf hin, dass ein Element optional ist. Arrayargumente In Syntaxbeschreibungen werden mithilfe von eckigen Klammern auch Arrays dargestellt. Im folgenden Beispiel wird die Syntax für das Cmdlet "Restart-Service" veranschaulicht: Restart-Service [-Name] <string[]> [-Include <string[]>] [-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>] Der Name-Parameter erfordert ein Argument. In diesem Fall wird der Name des neu zu startenden Diensts gefordert. Der Parameter kann eine durch Trennzeichen getrennte Liste von Diensten annehmen, wie im folgenden Beispiel veranschaulicht: Restart-Service RasAuto, RasMan, RemoteAccess SIEHE AUCH Get-Help C:\Windows>powershell get-help about_Comment_Based_Help -full
Microsoft Windows [Version 10.0.19045.3693]
Copyright (c) 2023 Microsoft Corporation.
ColorConsole [Version 3.7.1000] PowerShell 2.0-Export
