about_Command_Syntax

Artykuł
11/03/2023

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, aby ułatwić poprawne konstruowanie poleceń. W tym artykule wyjaśniono, jak interpretować diagramy składniowe.

Pobieranie składni polecenia

Istnieją dwa sposoby uzyskiwania składni polecenia: Get-Help i Get-Command.

Get-Command

Polecenie może służyć do uzyskiwania Get-Command informacji o dowolnym poleceniu w systemie. Użyj parametru Składnia , aby uzyskać składnię dla polecenia.

Get-Command Get-Command -Syntax

Get-Command [[-ArgumentList] <Object[]>] [-Verb <string[]>] [-Noun <string[]>]
 [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>]
 [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported]
 [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>]
 [<CommonParameters>]

Get-Command [[-Name] <string[]>] [[-ArgumentList] <Object[]>]
 [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>]
 [-CommandType <CommandTypes>] [-TotalCount <int>] [-Syntax] [-ShowCommandInfo]
 [-All] [-ListImported] [-ParameterName <string[]>]
 [-ParameterType <PSTypeName[]>] [-UseFuzzyMatching]
 [-FuzzyMinimumDistance <uint>] [-UseAbbreviationExpansion]
 [<CommonParameters>]

Get-Help

Polecenie Get-Help zawiera szczegółowe informacje o poleceniach programu PowerShell, w tym składni, szczegółowy opis polecenia cmdlet i parametrów oraz przykłady. Polecenie wyjściowe Get-Help rozpoczyna się od krótkiego opisu polecenia, po którym następuje składnia.

Get-Help Get-Command

Następujące dane wyjściowe zostały skrócone, aby skupić się na opisie składni.

NAME
    Get-Command

SYNOPSIS
    Gets all commands.

SYNTAX

    Get-Command [[-Name] <System.String[]>] [[-ArgumentList] <System.Object[]>]
    [-All] [-CommandType {Alias | Function | Filter | Cmdlet | ExternalScript |
    Application | Script | Workflow | Configuration | All}]
    [-FullyQualifiedModule <Microsoft.PowerShell.Commands.ModuleSpecification[]>]
    [-ListImported] [-Module <System.String[]>] [-ParameterName <System.String[]>]
    [-ParameterType <System.Management.Automation.PSTypeName[]>]
    [-ShowCommandInfo] [-Syntax] [-TotalCount <System.Int32>]
    [-UseAbbreviationExpansion] [-UseFuzzyMatching] [<CommonParameters>]

    Get-Command [[-ArgumentList] <System.Object[]>] [-All]
    [-FullyQualifiedModule <Microsoft.PowerShell.Commands.ModuleSpecification[]>]
    [-ListImported] [-Module <System.String[]>] [-Noun <System.String[]>]
    [-ParameterName <System.String[]>]
    [-ParameterType <System.Management.Automation.PSTypeName[]>]
    [-ShowCommandInfo] [-Syntax] [-TotalCount <System.Int32>]
    [-Verb <System.String[]>] [<CommonParameters>]
...

Dane wyjściowe elementu Get-Help różnią się nieco od danych wyjściowych polecenia Get-Command. Zwróć uwagę na różnicę w składni parametru CommandType . Get-Command wyświetla typ parametru [CommandTypes] jako wyliczenie, a jednocześnie Get-Help pokazuje możliwe wartości dla wyliczenia.

Zestawy parametrów

Parametry polecenia programu PowerShell są wymienione w zestawach parametrów. Polecenie programu PowerShell może mieć co najmniej jeden zestaw parametrów. Polecenie Get-Command cmdlet ma dwa zestawy parametrów, jak pokazano w poprzednich przykładach.

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 nie można używać parametrów w tym samym poleceniu, są one wymienione w oddzielnych zestawach parametrów.

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

$cmd = Get-Command Get-Random
$cmd.ParameterSets |
    Select-Object Name, IsDefault, @{n='Parameters';e={$_.ToString()}} |
    Format-Table -Wrap

Name                       IsDefault Parameters
----                       --------- ----------
RandomNumberParameterSet        True [[-Maximum] <Object>] [-SetSeed <int>]
                                     [-Minimum <Object>] [-Count <int>]
                                     [<CommonParameters>]
RandomListItemParameterSet     False [-InputObject] <Object[]> [-SetSeed <int>]
                                     [-Count <int>] [<CommonParameters>]
ShuffleParameterSet            False [-InputObject] <Object[]> -Shuffle
                                     [-SetSeed <int>] [<CommonParameters>]

Pierwszy zestaw parametrów zwraca co najmniej jedną losową liczbę i ma parametry Minimum, Maksimum i Liczba .
Drugi zestaw parametrów zwraca losowo wybrany obiekt z zestawu obiektów i zawiera parametry InputObject i Count .
Trzeci zestaw parametrów ma parametr Shuffle , który zwraca kolekcję obiektów w kolejności losowej, na przykład tasując talii kart.
Wszystkie zestawy parametrów mają parametr SetSeed i typowe parametry.

Te zestawy parametrów pokazują, że można użyć parametrów InputObject i Count w tym samym poleceniu, ale nie można używać parametrów Maximum i Shuffle razem.

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 używasz Get-Random parametrów bez parametrów, program PowerShell zakłada, że używasz zestawu parametrów RandomNumberParameterSet i zwraca liczbę losową.

Symbole na diagramach składniowych

Diagram składni zawiera nazwę polecenia, parametry polecenia i wartości parametrów.

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

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

Aby na przykład użyć parametru Name typu Get-Command, wpisz : Get-Command -Name.

Nawiasy kątowe < > wskazują tekst zastępczy. Nie wpisujesz nawiasów kątowych ani tekstu zastępczego w poleceniu. Zamiast tego zastąp go elementem, który opisuje.

Symbol zastępczy wewnątrz nawiasów kątowych identyfikuje typ platformy .NET wartości, którą przyjmuje parametr. Aby na przykład użyć parametru Get-Command Name polecenia cmdlet, należy zastąpić <string[]> ciąg jednym lub więcej ciągów rozdzielonych przecinkami (,).

Nawiasy dołączane do typu platformy [] .NET wskazują, że parametr może akceptować co najmniej jedną wartość tego typu. Wprowadź wartości jako listę rozdzielaną przecinkami.

Na przykład parametry New-Alias Nazwa i Wartość polecenia cmdlet przyjmują tylko jeden ciąg.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias -Name MyAlias -Value mycommand.exe
```
Ale parametr Name get-Process może przyjmować jeden lub więcej ciągów.
```
Get-Process [-Name] <string[]>
```
```
Get-Process -Name Explorer, Winlogon, Services
```
Parametry bez wartości

Niektóre parametry nie akceptują danych wejściowych, więc nie mają wartości parametru. Parametry bez wartości to parametry przełącznika. Parametry przełącznika są używane jak wartości logiczne. Domyślnie mają wartość $false. Jeśli używasz parametru przełącznika, wartość jest ustawiona na $truewartość .

Na przykład parametr Get-Command List Zaimportowany parametr to parametr przełącznika. Gdy używasz parametru List Import , polecenie cmdlet zwraca tylko polecenia zaimportowane z modułów w bieżącej sesji.
```
Get-Command [-ListImported]
```

Nawiasy [ ] wokół parametrów wskazują elementy opcjonalne. Parametr i jego wartość mogą być opcjonalne. Na przykład parametr CommandType wartości Get-Command i jego wartości są ujęte w nawiasy, ponieważ są one opcjonalne.
```
Get-Command [-CommandType <CommandTypes>]
```
Nawiasy wokół nazwy parametru, ale nie wartość parametru, wskazują, że nazwa parametru jest opcjonalna. Te parametry są znane jako parametry pozycyjne. Wartości parametrów muszą być prezentowane w prawidłowej kolejności, aby wartości były powiązane z poprawnym parametrem.

Na przykład w przypadku New-Alias polecenia cmdlet wymagane są wartości parametrów Name i Value , ale nazwy parametrów -Name i -Value, są opcjonalne.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias MyAlias mycommand.exe
```
W każdym zestawie parametrów parametry są wyświetlane w kolejności położenia. 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 położenia parametru, zobacz about_Parameters.
Nawiasy klamrowe {} wskazują "wyliczenie", czyli zestaw prawidłowych wartości dla parametru.

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

Na przykład składnia polecenia New-Alias cmdlet zawiera następujące wyliczenie wartości parametru Option :
```
New-Alias -Option {None | ReadOnly | Constant | Private | AllScope}
```
Nawiasy klamrowe i pionowe słupki wskazują, że można wybrać dowolną z wymienionych wartości parametru Opcji , na przykład ReadOnly lub AllScope.
```
New-Alias -Option ReadOnly
```