about_Command_Syntax
Korte beschrijving
Beschrijft de syntaxisdiagrammen die worden gebruikt in PowerShell.
Lange beschrijving
Met de cmdlets Get-Help en Get-Command worden syntaxisdiagrammen weergegeven zodat u opdrachten correct kunt maken. In dit onderwerp wordt uitgelegd hoe u de syntaxisdiagrammen interpreteert.
SYNTAXISDIAGRAMMEN
Elke alinea in een opdrachtsyntaxisdiagram vertegenwoordigt een geldige vorm van de opdracht.
Als u een opdracht wilt maken, volgt u het syntaxisdiagram van links naar rechts. Selecteer een van de optionele parameters en geef waarden op voor de tijdelijke aanduidingen.
PowerShell gebruikt de volgende notatie voor syntaxisdiagrammen.
<command-name> -<Required Parameter Name> <Required Parameter Value>
[-<Optional Parameter Name> <Optional Parameter Value>]
[-<Optional Switch Parameters>]
[-<Optional Parameter Name>] <Required Parameter Value>
Hier volgt de syntaxis voor de cmdlet New-Alias .
New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
[-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
[-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
De syntaxis is hoofdletters voor leesbaarheid, maar PowerShell is niet hoofdlettergevoelig.
Het syntaxisdiagram bevat de volgende elementen.
Opdrachtnaam
Opdrachten beginnen altijd met een opdrachtnaam, zoals New-Alias. Typ de opdrachtnaam of de alias, zoals een 'gcm' voor Get-Command.
Parameters
De parameters van een opdracht zijn opties die bepalen wat de opdracht doet. Bij sommige parameters wordt een 'waarde' gebruikt. Dit is gebruikersinvoer voor de opdracht.
De opdracht heeft bijvoorbeeld Get-Help een naamparameter waarmee u de naam kunt opgeven van het onderwerp waarvoor help wordt weergegeven. De onderwerpnaam is de waarde van de parameter Name .
In een PowerShell-opdracht beginnen parameternamen altijd met een afbreekstreepje. Het afbreekstreepje vertelt PowerShell dat het item in de opdracht een parameternaam is.
Als u bijvoorbeeld de parameter Name van New-Aliaswilt gebruiken, typt u het volgende:
-Name
Parameters kunnen verplicht of optioneel zijn. In een syntaxisdiagram worden optionele items tussen vierkante haken [ ]geplaatst.
Zie about_Parameters voor meer informatie over parameters.
Parameterwaarden
Een parameterwaarde is de invoer die de parameter gebruikt. Omdat Windows PowerShell is gebaseerd op de Microsoft .NET Framework, worden parameterwaarden in het syntaxisdiagram weergegeven met hun .NET-type.
De parameter Name van Get-Help heeft bijvoorbeeld de waarde 'Tekenreeks', een tekenreeks, zoals één woord of meerdere woorden tussen aanhalingstekens.
[-Name] <string>
Het .NET-type van een parameterwaarde wordt tussen punthaken < > geplaatst om aan te geven dat het een tijdelijke aanduiding is voor een waarde en niet voor een letterlijke waarde die u in een opdracht typt.
Als u de parameter wilt gebruiken, vervangt u de tijdelijke aanduiding voor .NET-type door een object met het opgegeven .NET-type.
Als u bijvoorbeeld de parameter Name wilt gebruiken, typt u '-Name' gevolgd door een tekenreeks, zoals de volgende:
-Name MyAlias
Parameters zonder waarden
Sommige parameters accepteren geen invoer, dus ze hebben geen parameterwaarde. Parameters zonder waarden worden 'schakelparameters' genoemd omdat ze werken als aan/uit-schakelaars. U neemt ze op (aan) of u laat ze weg (uit) in een opdracht.
Als u een switchparameter wilt gebruiken, typt u de parameternaam, voorafgegaan door een afbreekstreepje.
Als u bijvoorbeeld de parameter WhatIf van de New-Alias cmdlet wilt gebruiken, typt u het volgende:
-WhatIf
Parametersets
De parameters van een opdracht worden weergegeven in parametersets. Parametersets zien eruit als de alinea's van een syntaxisdiagram.
De New-Alias cmdlet heeft één parameterset, maar veel cmdlets hebben meerdere parametersets. Sommige cmdlet-parameters zijn uniek voor een parameterset en andere worden weergegeven in meerdere parametersets. Elke parameterset vertegenwoordigt de indeling van een geldige opdracht. Een parameterset bevat alleen parameters die samen in een opdracht kunnen worden gebruikt. Als parameters niet in dezelfde opdracht kunnen worden gebruikt, worden ze weergegeven in afzonderlijke parametersets.
De cmdlet Get-Random heeft bijvoorbeeld de volgende parametersets:
Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
[<CommonParameters>]
Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
[<CommonParameters>]
De eerste parameterset, die een willekeurig getal retourneert, heeft de parameters Minimum en Maximum . De tweede parameterset, die een willekeurig geselecteerd object uit een set objecten retourneert, bevat de parameters InputObject en Count . Beide parametersets hebben de parameter SetSeed en de algemene parameters.
Deze parametersets geven aan dat u de parameters InputObject en Count in dezelfde opdracht kunt gebruiken, maar u kunt de parameters Maximum en Aantal niet in dezelfde opdracht gebruiken.
U geeft aan welke parameterset u wilt gebruiken met behulp van de parameters in die parameterset.
Elke cmdlet heeft echter ook een standaardparameterset. De standaardparameterset wordt gebruikt wanneer u geen parameters opgeeft die uniek zijn voor een parameterset. Als u bijvoorbeeld zonder parameters gebruiktGet-Random, wordt Windows PowerShell ervan uitgegaan dat u de parameterset Getal gebruikt en een willekeurig getal retourneert.
In elke parameterset worden de parameters weergegeven in positievolgorde. De volgorde van parameters in een opdracht is alleen van belang wanneer u de optionele parameternamen weglaat. Wanneer u parameternamen weglaat, wijst PowerShell waarden toe aan parameters op basis van positie en type. Zie voor meer informatie over parameterpositie about_Parameters.
Symbolen in syntaxisdiagrammen
Het syntaxisdiagram bevat de opdrachtnaam, de opdrachtparameters en de parameterwaarden. Er worden ook symbolen gebruikt om te laten zien hoe u een geldige opdracht maakt.
De syntaxisdiagrammen gebruiken de volgende symbolen:
Een afbreekstreepje
-geeft een parameternaam aan. Typ in een opdracht het afbreekstreepje direct vóór de parameternaam zonder tussenliggende spaties, zoals wordt weergegeven in het syntaxisdiagram.Als u bijvoorbeeld de parameter Name van
New-Aliaswilt gebruiken, typt u:-NamePunthaken
<>geven tijdelijke aanduidingen voor tekst aan. U typt de punthaken of de tekst van de tijdelijke aanduiding niet in een opdracht. In plaats daarvan vervangt u deze door het item dat wordt beschreven.Hoekhaken worden gebruikt om het .NET-type te identificeren van de waarde die een parameter gebruikt. Als u bijvoorbeeld de parameter Name van de
New-Aliascmdlet wilt gebruiken, vervangt u de<string>door een tekenreeks. Dit is een enkel woord of een groep woorden tussen aanhalingstekens.Vierkante haken
[ ]geven optionele items aan. Een parameter en de bijbehorende waarde kunnen optioneel zijn, of de naam van een vereiste parameter kan optioneel zijn.De beschrijvingsparameter van
New-Aliasen de bijbehorende waarde staan bijvoorbeeld tussen vierkante haken omdat ze beide optioneel zijn.[-Description <string>]De haakjes geven ook aan dat de parameterwaarde
<string>Name vereist is, maar de parameternaam 'Naam' is optioneel.[-Name] <string>Een haakje
[]rechts en links dat is toegevoegd aan een .NET-type geeft aan dat de parameter een of meer waarden van dat type kan accepteren. Voer de waarden in een door komma's gescheiden lijst in.De parameter Name van de
New-Aliascmdlet heeft bijvoorbeeld slechts één tekenreeks, maar de parameter Name van Get-Process kan een of meer tekenreeksen bevatten.New-Alias [-Name] <string> New-Alias -Name MyAliasGet-Process [-Name] <string[]> Get-Process -Name Explorer, Winlogon, ServicesAccolades
{}geven een 'opsomming' aan. Dit is een set geldige waarden voor een parameter.De waarden in de accolades worden gescheiden door verticale balken
|. Deze balken geven een 'exclusieve OF'-keuze aan, wat betekent dat u slechts één waarde kunt kiezen uit de set waarden die tussen de accolades worden weergegeven.De syntaxis voor de
New-Aliascmdlet bevat bijvoorbeeld de volgende opsomming van waarden voor de parameter Option :-Option {None | ReadOnly | Constant | Private | AllScope}De accolades en verticale balken geven aan dat u een van de vermelde waarden voor de parameter Option kunt kiezen, zoals 'ReadOnly' of 'AllScope'.
-Option ReadOnly
Optionele items
Vierkante haken [] om optionele items. In de syntaxisbeschrijving van de New-Alias cmdlet is de parameter Bereik bijvoorbeeld optioneel. Dit wordt aangegeven in de syntaxis met de vierkante haken rond de parameternaam en het type:
[-Scope <string>]
Beide volgende voorbeelden zijn correct gebruik van de New-Alias cmdlet:
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope Global
Een parameternaam kan optioneel zijn, zelfs als de waarde voor die parameter vereist is. Dit wordt aangegeven in de syntaxis door de vierkante haken rond de parameternaam, maar niet het parametertype, zoals in dit voorbeeld van de New-Alias cmdlet:
[-Name] <string> [-Value] <string>
Met de volgende opdrachten wordt de New-Alias cmdlet correct gebruikt. De opdrachten produceren hetzelfde resultaat.
New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData
Als de parameternaam niet is opgenomen in de instructie zoals getypt, probeert Windows PowerShell de positie van de argumenten te gebruiken om de waarden toe te wijzen aan parameters.
Het volgende voorbeeld is niet volledig:
New-Alias utd
Voor deze cmdlet zijn waarden vereist voor de parameters Naam en Waarde .
In syntaxisvoorbeelden worden vierkante haken ook gebruikt bij het benoemen en casten van .NET Framework typen. In deze context geven vierkante haken niet aan dat een element optioneel is.