Składnia polecenia — informacjeAbout Command Syntax

KRÓTKI OPISSHORT DESCRIPTION

Opisuje diagramy składni, które są używane w programie PowerShell.Describes the syntax diagrams that are used in PowerShell.

DŁUGI OPISLONG DESCRIPTION

Polecenia cmdlet Get-Help i Get-Command wyświetlają diagramy składni, aby pomóc w poprawnym tworzeniu poleceń.The Get-Help and Get-Command cmdlets display syntax diagrams to help you construct commands correctly. W tym temacie wyjaśniono sposób interpretacji diagramów składni.This topic explains how to interpret the syntax diagrams.

DIAGRAMY SKŁADNISYNTAX DIAGRAMS

Każdy akapit w diagramie składni poleceń reprezentuje prawidłową postać polecenia.Each paragraph in a command syntax diagram represents a valid form of the command.

Aby skonstruować polecenie, postępuj zgodnie ze schematem składni od lewej do prawej.To construct a command, follow the syntax diagram from left to right. Wybierz spośród parametrów opcjonalnych i podaj wartości dla symboli zastępczych.Select from among the optional parameters and provide values for the placeholders.

Program PowerShell używa następującej notacji dla diagramów składni.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>

Poniżej przedstawiono składnię polecenia cmdlet 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>]

Składnia jest Wielka litera na potrzeby czytelności, ale w programie PowerShell nie jest rozróżniana wielkość liter.The syntax is capitalized for readability, but PowerShell is case-insensitive.

Diagram składni zawiera następujące elementy.The syntax diagram has the following elements.

Nazwa poleceniaCommand name

Polecenia zawsze zaczynają się od nazwy polecenia, na przykład New-Alias .Commands always begin with a command name, such as New-Alias. Wpisz nazwę polecenia lub jego alias, na przykład "GCM" Get-Command .Type the command name or its alias, such a "gcm" for Get-Command.

ParametryParameters

Parametry polecenia to opcje, które określają działanie polecenia.The parameters of a command are options that determine what the command does. Niektóre parametry przyjmują "wartość", czyli dane wejściowe użytkownika do polecenia.Some parameters take a "value" which is user input to the command.

Na przykład Get-Help polecenie ma parametr name , który pozwala określić nazwę tematu, dla którego jest wyświetlana pomoc.For example, the Get-Help command has a Name parameter that lets you specify the name of the topic for which help is displayed. Nazwa tematu jest wartością parametru name .The topic name is the value of the Name parameter.

W poleceniu programu PowerShell nazwy parametrów zawsze zaczynają się łącznikiem.In a PowerShell command, parameter names always begin with a hyphen. Łącznik informuje program PowerShell, że element w poleceniu jest nazwą parametru.The hyphen tells PowerShell that the item in the command is a parameter name.

Na przykład, aby użyć parametru name New-Alias , wpisz następujące polecenie:For example, to use the Name parameter of New-Alias, you type the following:

-Name

Parametry mogą być obowiązkowe lub opcjonalne.Parameters can be mandatory or optional. W diagramie składni elementy opcjonalne są ujęte w nawiasy klamrowe [ ] .In a syntax diagram, optional items are enclosed in brackets [ ].

Aby uzyskać więcej informacji o parametrach, zobacz about_Parameters.For more information about parameters, see about_Parameters.

Wartości parametrówParameter Values

Wartość parametru to dane wejściowe, które pobiera parametr.A parameter value is the input that the parameter takes. Ponieważ program Windows PowerShell jest oparty na strukturze Microsoft .NET, wartości parametrów są reprezentowane w diagramie składni według ich typu .NET.Because Windows PowerShell is based on the Microsoft .NET Framework, parameter values are represented in the syntax diagram by their .NET type.

Na przykład parametr name Get-Help przyjmuje wartość "String", która jest ciągiem tekstowym, takim jak pojedynczy wyraz lub wiele słów ujętych w cudzysłów.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>

Typ .NET wartości parametru jest ujęty w nawiasy kątowe < > , aby wskazać, że jest symbolem zastępczym dla wartości, a nie literałem wpisanym w poleceniu.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.

Aby użyć parametru, Zastąp symbol zastępczy typu .NET obiektem, który ma określony typ .NET.To use the parameter, replace the .NET type placeholder with an object that has the specified .NET type.

Na przykład, aby użyć parametru name , wpisz "-name", po którym następuje ciąg, na przykład:For example, to use the Name parameter, type "-Name" followed by a string, such as the following:

-Name MyAlias

Parametry bez wartościParameters with no values

Niektóre parametry nie akceptują danych wejściowych, więc nie mają wartości parametru.Some parameters do not accept input, so they do not have a parameter value. Parametry bez wartości są nazywane "przełącznikami parametrów", ponieważ działają na przełącznikach Włącz/Wyłącz.Parameters without values are called "switch parameters" because they work like on/off switches. Są one uwzględniane (włączone) lub pomijane (wyłączone) za pomocą polecenia.You include them (on) or you omit them (off) from a command.

Aby użyć parametru Switch, po prostu wpisz nazwę parametru poprzedzoną myślnikiem.To use a switch parameter, just type the parameter name, preceded by a hyphen.

Na przykład, aby użyć parametru whatIf New-Alias polecenia cmdlet, wpisz następujące polecenie:For example, to use the WhatIf parameter of the New-Alias cmdlet, type the following:

-WhatIf

Zestawy parametrówParameter Sets

Parametry polecenia są wymienione w zestawach parametrów.The parameters of a command are listed in parameter sets. Zestawy parametrów wyglądają jak akapity diagramu składni.Parameter sets look like the paragraphs of a syntax diagram.

New-AliasPolecenie cmdlet ma jeden zestaw parametrów, ale wiele poleceń cmdlet ma wiele zestawów parametrów.The New-Alias cmdlet has one parameter set, but many cmdlets have multiple parameter sets. Niektóre parametry polecenia cmdlet są unikatowe dla zestawu parametrów, a inne są wyświetlane w wielu zestawach parametrów.Some of the cmdlet parameters are unique to a parameter set, and others appear in multiple parameter sets. Każdy zestaw parametrów reprezentuje format prawidłowe polecenie.Each parameter set represents the format of a valid command. Zestaw parametrów zawiera tylko parametry, które mogą być używane razem w poleceniu.A parameter set includes only parameters that can be used together in a command. Jeśli parametry nie mogą być używane w tym samym poleceniu, pojawiają się w osobnych zestawach parametrów.If parameters cannot be used in the same command, they appear in separate parameter sets.

Na przykład polecenie cmdlet Get-Random ma następujące zestawy parametrów: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>]

Pierwszy zestaw parametrów, który zwraca liczbę losową, ma minimalne i maksymalne parametry.The first parameter set, which returns a random number, has the Minimum and Maximum parameters. Drugi zestaw parametrów, który zwraca losowo wybrany obiekt z zestawu obiektów, zawiera parametry inputobject i Count .The second parameter set, which returns a randomly selected object from a set of objects, includes the InputObject and Count parameters. Oba zestawy parametrów mają parametr setinicjator i wspólne parametry.Both parameter sets have the SetSeed parameter and the common parameters.

Te zestawy parametrów wskazują, że można użyć parametrów inputobject i Count w tym samym poleceniu, ale nie można użyć parametrów Maximum i Count w tym samym poleceniu.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.

Należy wskazać, który zestaw parametrów ma być używany, używając parametrów w tym zestawie parametrów.You indicate which parameter set you want to use by using the parameters in that parameter set.

Jednak każde polecenie cmdlet ma również domyślny zestaw parametrów.However, every cmdlet also has a default parameter set. Domyślny zestaw parametrów jest używany, jeśli nie określisz parametrów, które są unikatowe dla zestawu parametrów.The default parameter set is used when you do not specify parameters that are unique to a parameter set. Na przykład jeśli używasz Get-Random bez parametrów, program Windows PowerShell przyjmuje, że używasz zestawu parametrów liczbowych i zwraca liczbę losową.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.

W każdym zestawie parametrów parametry są wyświetlane w kolejności położenia.In each parameter set, the parameters appear in position order. Kolejność parametrów w kwestiach poleceń tylko w przypadku pominięcia opcjonalnych nazw parametrów.The order of parameters in a command matters only when you omit the optional parameter names. Gdy nazwy parametrów są pomijane, program PowerShell przypisuje wartości do parametrów według pozycji i typu.When parameter names are omitted, PowerShell assigns values to parameters by position and type. Aby uzyskać więcej informacji na temat pozycji parametru, zobacz about_Parameters .For more information about parameter position, see about_Parameters.

Symbole w diagramach składniSymbols in Syntax Diagrams

Diagram składni zawiera listę nazw poleceń, parametrów poleceń i wartości parametrów.The syntax diagram lists the command name, the command parameters, and the parameter values. Używa również symboli, aby pokazać, jak utworzyć prawidłowe polecenie.It also uses symbols to show how to construct a valid command.

Na diagramach składni są używane następujące symbole:The syntax diagrams use the following symbols:

  • Łącznik - wskazuje nazwę parametru.A hyphen - indicates a parameter name. W poleceniu wpisz łącznik bezpośrednio przed nazwą parametru bez spacji, jak pokazano na diagramie składni.In a command, type the hyphen immediately before the parameter name with no intervening spaces, as shown in the syntax diagram.

    Na przykład, aby użyć parametru name New-Alias typu, wpisz:For example, to use the Name parameter of New-Alias, type:

    -Name
    
  • Nawiasy kątowe <> oznaczają tekst zastępczy.Angle brackets <> indicate placeholder text. Nie wpisz nawiasów kątowych ani tekstu zastępczego w poleceniu.You do not type the angle brackets or the placeholder text in a command. Zamiast tego należy zastąpić go elementem, który opisuje.Instead, you replace it with the item that it describes.

    Nawiasy kątowe służą do identyfikowania typu .NET wartości pobieranej przez parametr.Angle brackets are used to identify the .NET type of the value that a parameter takes. Na przykład, aby użyć parametru name New-Alias polecenia cmdlet, zastępuje się <string> ciągiem, który jest pojedynczym słowem lub grupą słów, które są ujęte w cudzysłów.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.

  • Nawiasy [ ] wskazują elementy opcjonalne.Brackets [ ] indicate optional items. Parametr i jego wartość mogą być opcjonalne lub nazwa wymaganego parametru może być opcjonalna.A parameter and its value can be optional, or the name of a required parameter can be optional.

    Na przykład parametr Description New-Alias i jego wartość są ujęte w nawiasy, ponieważ są one opcjonalne.For example, the Description parameter of New-Alias and its value are enclosed in brackets because they are both optional.

    [-Description <string>]
    

    Nawiasy wskazują również, że wartość parametru name <string> jest wymagana, ale nazwa parametru "name" jest opcjonalna.The brackets also indicate that the Name parameter value <string> is required, but the parameter name, "Name", is optional.

    [-Name] <string>
    
  • Lewy i prawy nawias [] dołączony do typu .NET wskazuje, że parametr może przyjmować jedną lub wiele wartości tego typu.A right and left bracket [] appended to a .NET type indicates that the parameter can accept one or multiple values of that type. Wprowadź wartości na liście rozdzielanej przecinkami.Enter the values in a comma-separated list.

    Na przykład parametr name New-Alias polecenia cmdlet przyjmuje tylko jeden ciąg, ale parametr name procesu Get-Process może przyjmować jeden lub wiele ciągów.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
    
  • Nawiasy klamrowe {} wskazują "Wyliczenie", które jest zestawem prawidłowych wartości dla parametru.Braces {} indicate an "enumeration," which is a set of valid values for a parameter.

    Wartości w nawiasach klamrowych są oddzielone pionowymi paskami | .The values in the braces are separated by vertical bars |. Te Słupki wskazują na wybór "wyłączny lub", co oznacza, że można wybrać tylko jedną wartość z zestawu wartości, które są wyświetlane w nawiasach klamrowych.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.

    Na przykład składnia New-Alias polecenia cmdlet zawiera następujące Wyliczenie wartości dla parametru Option :For example, the syntax for the New-Alias cmdlet includes the following value enumeration for the Option parameter:

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

    Nawiasy klamrowe i pionowe wskazują, że można wybrać jedną z wartości z listy dla parametru opcji , na przykład "ReadOnly" lub "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
    

Elementy opcjonalneOptional Items

Nawiasy [] otaczają opcjonalne elementy.Brackets [] surround optional items. Na przykład w New-Alias opisie składni polecenia cmdlet parametr SCOPE jest opcjonalny.For example, in the New-Alias cmdlet syntax description, the Scope parameter is optional. Jest to wskazane w składni według nawiasów wokół nazwy parametru i typu:This is indicated in the syntax by the brackets around the parameter name and type:

[-Scope <string>]

Oba poniższe przykłady są prawidłowymi użyciami New-Alias polecenia cmdlet: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

Nazwa parametru może być opcjonalna, nawet jeśli jest wymagana wartość dla tego parametru.A parameter name can be optional even if the value for that parameter is required. Jest to wskazane w składni przez nawiasy wokół nazwy parametru, ale nie typu parametru, jak w poniższym przykładzie z New-Alias polecenia 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>

Poniższe polecenia prawidłowo korzystają z New-Alias polecenia cmdlet.The following commands correctly use the New-Alias cmdlet. Polecenia te generują ten sam wynik.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

Jeśli nazwa parametru nie jest uwzględniona w instrukcji jako wpisanej, program Windows PowerShell próbuje użyć pozycji argumentów do przypisania wartości do parametrów.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.

Następujący przykład nie został ukończony:The following example is not complete:

New-Alias utd

To polecenie cmdlet wymaga wartości parametrów Nazwa i wartość .This cmdlet requires values for both the Name and Value parameters.

W przykładach składni, nawiasy są również używane podczas nadawania nazw i rzutowania na typy .NET Framework.In syntax examples, brackets are also used in naming and casting to .NET Framework types. W tym kontekście nawiasy nie wskazują, że element jest opcjonalny.In this context, brackets do not indicate an element is optional.

ZOBACZ RÓWNIEŻSEE ALSO