Om kommandosyntaxAbout Command Syntax

KORT BESKRIVNINGSHORT DESCRIPTION

Beskriver de syntax-diagram som används i PowerShell.Describes the syntax diagrams that are used in PowerShell.

LÅNG BESKRIVNINGLONG DESCRIPTION

Cmdletarna Get-Help och Get-Command visar syntax-diagram som hjälper dig att skapa kommandon på rätt sätt.The Get-Help and Get-Command cmdlets display syntax diagrams to help you construct commands correctly. I det här avsnittet beskrivs hur du tolkar syntax-diagram.This topic explains how to interpret the syntax diagrams.

SYNTAX DIAGRAMSYNTAX DIAGRAMS

Varje stycke i ett kommando för kommandosyntaxen representerar en giltig form av kommandot.Each paragraph in a command syntax diagram represents a valid form of the command.

Om du vill skapa ett kommando följer du syntaxen för diagrammet från vänster till höger.To construct a command, follow the syntax diagram from left to right. Välj bland de valfria parametrarna och ange värden för plats hållarna.Select from among the optional parameters and provide values for the placeholders.

PowerShell använder följande notation för syntax-diagram.PowerShell uses the following notation for syntax diagrams.

<command-name> -<Required Parameter Name> <Required Parameter Value>
[-<Optional Parameter Name> <Optional Parameter Value>]
[-<Optional Switch Parameters>]
[-<Optional Parameter Name>] <Required Parameter Value>

Följande är syntaxen för cmdleten New-alias .The following is the syntax for the New-Alias cmdlet.

New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
[-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
[-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Syntaxen är kapitaliserad för läsbarhet, men PowerShell är Skift läges okänsligt.The syntax is capitalized for readability, but PowerShell is case-insensitive.

Syntax-diagrammet innehåller följande element.The syntax diagram has the following elements.

Kommando namnCommand name

Kommandon börjar alltid med ett kommando namn, till exempel New-Alias .Commands always begin with a command name, such as New-Alias. Skriv kommando namnet eller dess alias, t. ex. "GCM" för Get-Command .Type the command name or its alias, such a "gcm" for Get-Command.

ParametrarParameters

Parametrarna för ett kommando är alternativ som avgör vad kommandot gör.The parameters of a command are options that determine what the command does. Vissa parametrar tar ett "värde" som är indata från användaren till kommandot.Some parameters take a "value" which is user input to the command.

Till exempel Get-Help har kommandot en namn parameter som gör att du kan ange namnet på det ämne som hjälpen visas för.For example, the Get-Help command has a Name parameter that lets you specify the name of the topic for which help is displayed. Ämnes namnet är värdet för parametern Name .The topic name is the value of the Name parameter.

I ett PowerShell-kommando börjar parameter namn alltid med ett bindestreck.In a PowerShell command, parameter names always begin with a hyphen. Bindestrecket talar om för PowerShell att objektet i kommandot är ett parameter namn.The hyphen tells PowerShell that the item in the command is a parameter name.

Om du till exempel vill använda namn parametern för New-Alias skriver du följande:For example, to use the Name parameter of New-Alias, you type the following:

-Name

Parametrar kan vara obligatoriska eller valfria.Parameters can be mandatory or optional. Valfria objekt omges av hakparenteser i ett syntax diagram [ ] .In a syntax diagram, optional items are enclosed in brackets [ ].

Mer information om parametrar finns i about_Parameters.For more information about parameters, see about_Parameters.

ParametervärdenParameter Values

Ett parameter värde är den Indatatyp som parametern tar.A parameter value is the input that the parameter takes. Eftersom Windows PowerShell baseras på Microsoft .NET Framework representeras parameter värden i syntax-diagrammet av deras .NET-typ.Because Windows PowerShell is based on the Microsoft .NET Framework, parameter values are represented in the syntax diagram by their .NET type.

Till exempel använder name-parametern för Get-Help ett "String"-värde, som är en text sträng, till exempel ett enstaka ord eller flera ord som omges av citat tecken.For example, the Name parameter of Get-Help takes a "String" value, which is a text string, such as a single word or multiple words enclosed in quotation marks.

[-Name] <string>

.NET-typen för ett parameter värde omges av vinkelparenteser < > för att indikera att den är plats hållare för ett värde och inte en literal som du skriver in i ett kommando.The .NET type of a parameter value is enclosed in angle brackets < > to indicate that it is placeholder for a value and not a literal that you type in a command.

Om du vill använda parametern ersätter du plats hållaren för .NET-typ med ett objekt som har den angivna .NET-typen.To use the parameter, replace the .NET type placeholder with an object that has the specified .NET type.

Om du till exempel vill använda namn parametern skriver du "-name" följt av en sträng, till exempel följande:For example, to use the Name parameter, type "-Name" followed by a string, such as the following:

-Name MyAlias

Parametrar utan värdenParameters with no values

Vissa parametrar accepterar inte indatatyper, så de har inte något parameter värde.Some parameters do not accept input, so they do not have a parameter value. Parametrar utan värden kallas "växla parametrar" eftersom de fungerar som på/av växlar.Parameters without values are called "switch parameters" because they work like on/off switches. Du inkluderar dem (på) eller utelämnar dem (av) från ett kommando.You include them (on) or you omit them (off) from a command.

Om du vill använda en växlings parameter skriver du bara parameter namnet och föregås av ett bindestreck.To use a switch parameter, just type the parameter name, preceded by a hyphen.

Om du till exempel vill använda parametern whatIf för New-Alias cmdleten skriver du följande:For example, to use the WhatIf parameter of the New-Alias cmdlet, type the following:

-WhatIf

Parameter uppsättningarParameter Sets

Parametrarna för ett kommando visas i parameter uppsättningar.The parameters of a command are listed in parameter sets. Parameter uppsättningar ser ut som stycken i ett syntax-diagram.Parameter sets look like the paragraphs of a syntax diagram.

New-AliasCmdleten har en parameter uppsättning, men många cmdlets har flera parameter uppsättningar.The New-Alias cmdlet has one parameter set, but many cmdlets have multiple parameter sets. Några av cmdlet-parametrarna är unika för en parameter uppsättning och andra visas i flera parameter uppsättningar.Some of the cmdlet parameters are unique to a parameter set, and others appear in multiple parameter sets. Varje parameter uppsättning representerar formatet för ett giltigt kommando.Each parameter set represents the format of a valid command. En parameter uppsättning inkluderar bara parametrar som kan användas tillsammans i ett kommando.A parameter set includes only parameters that can be used together in a command. Om det inte går att använda parametrar i samma kommando, visas de i separata parameter uppsättningar.If parameters cannot be used in the same command, they appear in separate parameter sets.

Till exempel har cmdleten Get-slumpmässig följande parameter uppsättningar:For example, the Get-Random cmdlet has the following parameter sets:

Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
[<CommonParameters>]

Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
[<CommonParameters>]

Den första parameter uppsättningen, som returnerar ett slumptal, har de lägsta och högsta parametrarna.The first parameter set, which returns a random number, has the Minimum and Maximum parameters. Den andra parameter uppsättningen, som returnerar ett slumpmässigt valt objekt från en uppsättning objekt, innehåller parametrarna InputObject och Count .The second parameter set, which returns a randomly selected object from a set of objects, includes the InputObject and Count parameters. Båda parameter uppsättningarna har parametern SetSeed och de gemensamma parametrarna.Both parameter sets have the SetSeed parameter and the common parameters.

Dessa parameter uppsättningar visar att du kan använda parametrarna InputObject och Count i samma kommando, men du kan inte använda parametrarna maximum och Count i samma kommando.These parameter sets indicate that you can use the InputObject and Count parameters in the same command, but you cannot use the Maximum and Count parameters in the same command.

Du anger vilken parameter uppsättning du vill använda med hjälp av parametrarna i den parameter uppsättningen.You indicate which parameter set you want to use by using the parameters in that parameter set.

Varje cmdlet har dock även en standard parameter uppsättning.However, every cmdlet also has a default parameter set. Standard parameter uppsättningen används när du inte anger parametrar som är unika för en parameter uppsättning.The default parameter set is used when you do not specify parameters that are unique to a parameter set. Om du till exempel använder Get-Random utan parametrar förutsätter Windows PowerShell att du använder den numeriska parameter uppsättningen och returnerar ett slumpmässigt nummer.For example, if you use Get-Random without parameters, Windows PowerShell assumes that you are using the Number parameter set and it returns a random number.

I varje parameter uppsättning visas parametrarna i positions ordning.In each parameter set, the parameters appear in position order. Ordningen på parametrarna i ett kommando fråga endast när du utelämnar valfria parameter namn.The order of parameters in a command matters only when you omit the optional parameter names. När parameter namn utelämnas tilldelar PowerShell värden till parametrar efter position och typ.When parameter names are omitted, PowerShell assigns values to parameters by position and type. Mer information om parameter placering finns i about_Parameters .For more information about parameter position, see about_Parameters.

Symboler i syntax diagramSymbols in Syntax Diagrams

I syntax-diagrammet visas kommando namn, kommando parametrar och parameter värden.The syntax diagram lists the command name, the command parameters, and the parameter values. Den använder också symboler för att visa hur du skapar ett giltigt kommando.It also uses symbols to show how to construct a valid command.

I syntax diagrammen används följande symboler:The syntax diagrams use the following symbols:

  • Ett bindestreck - anger ett parameter namn.A hyphen - indicates a parameter name. I ett kommando skriver du bindestrecket omedelbart före parameter namnet utan några mellanliggande blank steg, som du ser i syntax-diagrammet.In a command, type the hyphen immediately before the parameter name with no intervening spaces, as shown in the syntax diagram.

    Om du till exempel vill använda namn parametern för New-Alias skriver du:For example, to use the Name parameter of New-Alias, type:

    -Name
    
  • Vinkelparenteser <> visar platshållartext.Angle brackets <> indicate placeholder text. Du anger inte vinkelparenteser eller platshållartexten i ett kommando.You do not type the angle brackets or the placeholder text in a command. I stället ersätter du det med det objekt som beskrivs.Instead, you replace it with the item that it describes.

    Vinkelparenteser används för att identifiera .NET-typen för värdet som en parameter tar.Angle brackets are used to identify the .NET type of the value that a parameter takes. Om du till exempel vill använda parametern Name för New-Alias cmdlet: en, ersätter du <string> med en sträng, som är ett enstaka ord eller en grupp med ord som omges av citat tecken.For example, to use the Name parameter of the New-Alias cmdlet, you replace the <string> with a string, which is a single word or a group of words that are enclosed in quotation marks.

  • Hakparenteser [ ] indikerar valfria objekt.Brackets [ ] indicate optional items. En parameter och dess värde kan vara valfritt, eller så kan namnet på en obligatorisk parameter vara valfritt.A parameter and its value can be optional, or the name of a required parameter can be optional.

    Exempel: beskrivnings parametern för New-Alias och dess värde omges av hakparenteser eftersom de båda är valfria.For example, the Description parameter of New-Alias and its value are enclosed in brackets because they are both optional.

    [-Description <string>]
    

    Hakparenteserna visar också att värdet för namn parametern <string> är obligatoriskt, men parameter namnet, "name", är valfritt.The brackets also indicate that the Name parameter value <string> is required, but the parameter name, "Name", is optional.

    [-Name] <string>
    
  • En höger-och vänsterparentes [] som läggs till i en .net-typ indikerar att parametern kan acceptera ett eller flera värden av den typen.A right and left bracket [] appended to a .NET type indicates that the parameter can accept one or multiple values of that type. Ange värdena i en kommaavgränsad lista.Enter the values in a comma-separated list.

    Till exempel tar cmdleten Name -parametern New-Alias bara en sträng, men namn parametern för Get-process kan ta en eller flera strängar.For example, the Name parameter of the New-Alias cmdlet takes only one string, but the Name parameter of Get-Process can take one or many strings.

    New-Alias [-Name] <string>
    
    New-Alias -Name MyAlias
    
    Get-Process [-Name] <string[]>
    
    Get-Process -Name Explorer, Winlogon, Services
    
  • Klammerparenteser {} anger en "uppräkning", som är en uppsättning giltiga värden för en parameter.Braces {} indicate an "enumeration," which is a set of valid values for a parameter.

    Värdena i klamrarna separeras med lodräta staplar | .The values in the braces are separated by vertical bars |. Staplarna visar ett "exklusivt OR"-alternativ, vilket innebär att du bara kan välja ett värde från den uppsättning värden som visas innanför klammerparenteserna.These bars indicate an "exclusive OR" choice, meaning that you can choose only one value from the set of values that are listed inside the braces.

    Syntaxen för New-Alias cmdleten innehåller till exempel följande värde uppräkning för alternativ parametern:For example, the syntax for the New-Alias cmdlet includes the following value enumeration for the Option parameter:

    -Option {None | ReadOnly | Constant | Private | AllScope}
    

    Klamrarna och de lodräta staplarna visar att du kan välja något av de angivna värdena för alternativ parametern, till exempel "ReadOnly" eller "AllScope".The braces and vertical bars indicate that you can choose any one of the listed values for the Option parameter, such as "ReadOnly" or "AllScope".

    -Option ReadOnly
    

Valfria objektOptional Items

Hakparenteser [] omger valfria objekt.Brackets [] surround optional items. I New-Alias beskrivningen för cmdlet-syntaxen är till exempel parametern omfattning valfri.For example, in the New-Alias cmdlet syntax description, the Scope parameter is optional. Detta anges i syntaxen med hakparenteserna Runt parameter namnet och typen:This is indicated in the syntax by the brackets around the parameter name and type:

[-Scope <string>]

Följande exempel är korrekt användning av New-Alias cmdleten:Both the following examples are correct uses of the New-Alias cmdlet:

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope Global

Ett parameter namn kan vara valfritt även om värdet för den parametern är obligatoriskt.A parameter name can be optional even if the value for that parameter is required. Detta anges i syntaxen med hakparenteserna Runt parameter namnet men inte parameter typen, som i det här exemplet från New-Alias cmdlet:This is indicated in the syntax by the brackets around the parameter name but not the parameter type, as in this example from the New-Alias cmdlet:

[-Name] <string> [-Value] <string>

Följande kommandon använder New-Alias cmdleten korrekt.The following commands correctly use the New-Alias cmdlet. Kommandona ger samma resultat.The commands produce the same result.

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData

Om parameter namnet inte ingår i instruktionen som skrivet försöker Windows PowerShell använda positionen för argumenten för att tilldela värdena till parametrar.If the parameter name is not included in the statement as typed, Windows PowerShell tries to use the position of the arguments to assign the values to parameters.

Följande exempel är inte klart:The following example is not complete:

New-Alias utd

Denna cmdlet kräver värden för både namn -och värde parametrarna.This cmdlet requires values for both the Name and Value parameters.

I syntaxen används hakparenteser även för namngivning och databyte till .NET Framework typer.In syntax examples, brackets are also used in naming and casting to .NET Framework types. I det här sammanhanget anger hakparenteser inte ett element är valfritt.In this context, brackets do not indicate an element is optional.

SE ÄVENSEE ALSO