about_Command_Syntax

Krótki opis

Opisuje diagramy składni używane w programie PowerShell.

Długi opis

Polecenia cmdlet Get-Help i Get-Command wyświetlają diagramy składni, które ułatwiają poprawne konstruowanie poleceń. W tym temacie wyjaśniono, jak interpretować diagramy składni.

DIAGRAMY SKŁADNI

Każdy akapit na diagramie składni polecenia reprezentuje prawidłową formę polecenia.

Aby utworzyć polecenie, postępuj zgodnie z diagramem składni od lewej do prawej. Wybierz spośród opcjonalnych parametrów i podaj wartości dla symboli zastępczych.

Program PowerShell używa następującej notacji dla diagramów składniowych.

<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 .

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

Składnia jest wielkich liter w celu czytelności, ale program PowerShell nie uwzględnia wielkości liter.

Diagram składniowy zawiera następujące elementy.

Nazwa polecenia

Polecenia zawsze zaczynają się od nazwy polecenia, takiej jak New-Alias. Wpisz nazwę polecenia lub jego alias, taki jak "gcm" dla .Get-Command

Parametry

Parametry polecenia to opcje, które określają, co robi polecenie. Niektóre parametry przyjmują wartość "value", która jest danymi wejściowymi użytkownika w poleceniu.

Na przykład polecenie ma parametr Name, Get-Help który umożliwia określenie nazwy tematu, dla którego jest wyświetlana pomoc. Nazwa tematu jest wartością parametru Name .

W poleceniu programu PowerShell nazwy parametrów zawsze zaczynają się łącznikiem. Łącznik informuje program PowerShell, że element w poleceniu jest nazwą parametru.

Aby na przykład użyć parametru Name klasy New-Alias, należy wpisać następujące polecenie:

-Name

Parametry mogą być obowiązkowe lub opcjonalne. Na diagramie składni opcjonalne elementy są ujęte w nawiasy kwadratowe [ ].

Aby uzyskać więcej informacji na temat parametrów, zobacz about_Parameters.

Wartości parametrów

Wartość parametru to dane wejściowe, które przyjmuje parametr. Ponieważ Windows PowerShell opiera się na .NET Framework firmy Microsoft, wartości parametrów są reprezentowane na diagramie składniowym według typu .NET.

Na przykład parametr Name parametru Get-Help przyjmuje wartość "Ciąg", która jest ciągiem tekstowym, takim jak pojedynczy wyraz lub wiele wyrazów ujęta w znaki cudzysłowu.

[-Name] <string>

Typ .NET wartości parametru jest ujęta w nawiasy kątowe < > , aby wskazać, że jest symbolem zastępczym dla wartości, a nie literału wpisywanego w poleceniu.

Aby użyć parametru, zastąp symbol zastępczy typu .NET obiektem, który ma określony typ platformy .NET.

Aby na przykład użyć parametru Nazwa , wpisz ciąg "-Name", po którym następuje ciąg, taki jak:

-Name MyAlias

Parametry bez wartości

Niektóre parametry nie akceptują danych wejściowych, więc nie mają wartości parametru. Parametry bez wartości są nazywane "parametrami przełącznika", ponieważ działają jak przełączniki. Należy je uwzględnić (włączone) lub pominąć (wyłączyć) z polecenia.

Aby użyć parametru przełącznika, po prostu wpisz nazwę parametru poprzedzonego łącznikiem.

Aby na przykład użyć parametru New-AliasWhatIf polecenia cmdlet, wpisz następujące polecenie:

-WhatIf

Zestawy parametrów

Parametry polecenia są wymienione w zestawach parametrów. Zestawy parametrów wyglądają jak akapity diagramu składni.

Polecenie New-Alias cmdlet ma jeden zestaw parametrów, ale wiele poleceń cmdlet ma wiele zestawów parametrów. Niektóre parametry polecenia cmdlet są unikatowe dla zestawu parametrów, a inne są wyświetlane w wielu zestawach parametrów. Każdy zestaw parametrów reprezentuje format prawidłowego polecenia. Zestaw parametrów zawiera tylko parametry, które mogą być używane razem w poleceniu. Jeśli parametrów nie można użyć w tym samym poleceniu, są one wyświetlane w oddzielnych zestawach parametrów.

Na przykład polecenie cmdlet Get-Random ma następujące zestawy parametrów:

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 parametry Minimum i Maksimum . Drugi zestaw parametrów, który zwraca losowo wybrany obiekt z zestawu obiektów, zawiera parametry InputObject i Count . Oba zestawy parametrów mają parametr SetSeed i wspólne parametry.

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 Maksimum i Liczba w tym samym poleceniu.

Wskazujesz, który zestaw parametrów chcesz użyć przy użyciu parametrów w tym zestawie parametrów.

Jednak każde polecenie cmdlet ma również domyślny zestaw parametrów. Domyślny zestaw parametrów jest używany, gdy nie określasz parametrów unikatowych dla zestawu parametrów. Jeśli na przykład nie używasz Get-Random parametrów, Windows PowerShell zakłada, że używasz zestawu parametrów Liczba i zwraca liczbę losową.

W każdym zestawie parametrów parametry są wyświetlane w kolejności pozycji. Kolejność parametrów w poleceniu ma znaczenie tylko wtedy, gdy pominięto opcjonalne nazwy parametrów. Gdy nazwy parametrów zostaną pominięte, program PowerShell przypisuje wartości do parametrów według pozycji i typu. Aby uzyskać więcej informacji na temat pozycji parametru, zobacz about_Parameters.

Symbole na diagramach składniowych

Diagram składni zawiera nazwę polecenia, parametry polecenia i wartości parametrów. Używa również symboli, aby pokazać, jak skonstruować prawidłowe polecenie.

Diagramy składni używają następujących symboli:

  • Łącznik - wskazuje nazwę parametru. W poleceniu wpisz łącznik bezpośrednio przed nazwą parametru bez interweniujących spacji, jak pokazano na diagramie składniowym.

    Aby na przykład użyć parametru Name typu New-Alias, wpisz:

    -Name
    
  • Nawiasy kątowe <> wskazują tekst zastępczy. Nie należy wpisywać nawiasów kątowych ani tekstu zastępczego w poleceniu. Zamiast tego zastąp go elementem, który opisuje.

    Nawiasy kątowe służą do identyfikowania typu .NET wartości, którą przyjmuje parametr. Aby na przykład użyć parametru New-AliasName polecenia cmdlet, zastąp <string> ciąg ciągiem , który jest pojedynczym słowem lub grupą wyrazów ujętą w znaki cudzysłowu.

  • Nawiasy [ ] wskazują elementy opcjonalne. Parametr i jego wartość mogą być opcjonalne lub nazwa wymaganego parametru może być opcjonalna.

    Na przykład parametr Description i New-Alias jego wartość są ujęte w nawiasy, ponieważ są opcjonalne.

    [-Description <string>]
    

    Nawiasy wskazują również, że wartość <string> parametru Name jest wymagana, ale nazwa parametru "Name" jest opcjonalna.

    [-Name] <string>
    
  • Prawy i lewy nawias [] dołączany do typu platformy .NET wskazuje, że parametr może akceptować jedną lub wiele wartości tego typu. Wprowadź wartości na liście rozdzielanej przecinkami.

    Na przykład parametr New-AliasName polecenia cmdlet przyjmuje tylko jeden ciąg, ale parametr Nameget-Process może przyjmować jeden lub wiele ciągów.

    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.

    Wartości w nawiasach klamrowych są oddzielone pionowymi słupkami |. Te słupki wskazują wybór "wyłączny OR", co oznacza, że można wybrać tylko jedną wartość z zestawu wartości wymienionych wewnątrz nawiasów klamrowych.

    Na przykład składnia New-Alias polecenia cmdlet zawiera następujące wyliczenie wartości parametru Option :

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

    Nawiasy klamrowe i pionowe słupki wskazują, że można wybrać dowolną z wymienionych wartości parametru Opcja , taką jak "ReadOnly" lub "AllScope".

    -Option ReadOnly
    

Elementy opcjonalne

Nawiasy [] otaczają elementy opcjonalne. Na przykład w opisie New-Alias składni polecenia cmdlet parametr Zakres jest opcjonalny. Jest to wskazane w składni nawiasów wokół nazwy parametru i typu:

[-Scope <string>]

Oba poniższe przykłady są poprawnymi zastosowaniami New-Alias polecenia 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 wartość tego parametru jest wymagana. Jest to wskazane w składni nawiasów kwadratowych wokół nazwy parametru, ale nie typu parametru, jak w tym przykładzie New-Alias z polecenia cmdlet:

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

Następujące polecenia poprawnie używają New-Alias polecenia cmdlet . Polecenia generują ten sam wynik.

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 typdowane, Windows PowerShell próbuje użyć pozycji argumentów w celu przypisania wartości do parametrów.

Poniższy przykład nie został ukończony:

New-Alias utd

To polecenie cmdlet wymaga wartości parametrów Name i Value .

W przykładach składni nawiasy kwadratowe są również używane w nazewnictwie i rzutowaniu do typów .NET Framework. W tym kontekście nawiasy nie wskazują, że element jest opcjonalny.

Zobacz też