about_Command_Syntax

Článek
11/03/2023

Krátký popis

Popisuje diagramy syntaxe, které se používají v PowerShellu.

Dlouhý popis

Rutiny Get-Help a Get-Command zobrazují diagramy syntaxe, které vám pomůžou správně vytvářet příkazy. Tento článek vysvětluje, jak interpretovat diagramy syntaxe.

Získání syntaxe příkazu

Syntaxi příkazu lze získat dvěma způsoby: Get-Help a Get-Command.

Get-Command

Tento Get-Command příkaz lze použít k získání informací o jakémkoli příkazu v systému. Pomocí parametru Syntax získáte syntaxi příkazu.

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

Tento Get-Help příkaz poskytuje podrobné informace o příkazech PowerShellu, včetně syntaxe, podrobného popisu rutiny a parametrů a příkladů. Výstupní Get-Help příkaz začíná stručným popisem příkazu, za kterým následuje syntaxe.

Get-Help Get-Command

Následující výstup byl zkrácen, aby se zaměřil na popis syntaxe.

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

Výstup Get-Help se mírně liší od výstupu Get-Command. Všimněte si rozdílu v syntaxi parametru CommandType . Get-Command zobrazuje typ parametru [CommandTypes] jako výčet, zatímco Get-Help zobrazuje možné hodnoty výčtu.

Sady parametrů

Parametry příkazu PowerShellu jsou uvedeny v sadách parametrů. Příkaz PowerShellu může mít jednu nebo více sad parametrů. Rutina Get-Command má dvě sady parametrů, jak je znázorněno v předchozích příkladech.

Některé parametry rutiny jsou jedinečné pro sadu parametrů a jiné se zobrazují v několika sadách parametrů. Každá sada parametrů představuje formát platného příkazu. Sada parametrů obsahuje pouze parametry, které lze použít společně v příkazu. Pokud se parametry nedají použít ve stejném příkazu, jsou uvedené v samostatných sadách parametrů.

Například rutina Get-Random obsahuje následující sady parametrů:

$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>]

První sada parametrů vrátí jedno nebo více náhodných čísel a má parametry Minimum, Maximum a Count .
Druhá sada parametrů vrátí náhodně vybraný objekt ze sady objektů a obsahuje parametry InputObject a Count .
Třetí sada parametrů má parametr Shuffle , který vrací kolekci objektů v náhodném pořadí, jako je náhodné prohazování balíčku karet.
Všechny sady parametrů mají parametr SetSeed a společné parametry.

Tyto sady parametrů ukazují, že můžete použít parametry InputObject a Count ve stejném příkazu, ale nemůžete použít parametry Maximum a Shuffle společně.

Každá rutina má také výchozí sadu parametrů. Výchozí sada parametrů se používá, když nezadáte parametry, které jsou jedinečné pro sadu parametrů. Pokud například použijete Get-Random bez parametrů, PowerShell předpokládá, že používáte sadu parametrů RandomNumberParameterSet a vrací náhodné číslo.

Symboly v diagramech syntaxe

V diagramu syntaxe je uveden název příkazu, parametry příkazu a hodnoty parametrů.

Diagramy syntaxe používají následující symboly:

Spojovník - označuje název parametru. V příkazu zadejte spojovník bezprostředně před název parametru bez mezer, jak je znázorněno v diagramu syntaxe.

Pokud chcete například použít parametr Name , Get-Commandzadejte: Get-Command -Name.

Lomené závorky < > označují zástupný text. Do příkazu nezadáte úhlové závorky ani zástupný text. Místo toho ji nahradíte položkou, kterou popisuje.

Zástupný symbol uvnitř úhlových závorek identifikuje typ .NET hodnoty, kterou má parametr. Pokud například chcete použít parametr Name rutiny, nahradíte <string[]> ho jedním nebo více řetězci oddělenými čárkami (,).Get-Command

Závorky [] připojené k typu .NET označují, že parametr může přijmout jednu nebo více hodnot tohoto typu. Zadejte hodnoty jako seznam oddělený čárkami.

Například parametry Name a Value rutiny New-Alias přebírají pouze jeden řetězec.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias -Name MyAlias -Value mycommand.exe
```
Parametr Name metody Get-Process ale může obsahovat jeden nebo více řetězců.
```
Get-Process [-Name] <string[]>
```
```
Get-Process -Name Explorer, Winlogon, Services
```
Parametry bez hodnot

Některé parametry nepřijímají vstup, takže nemají hodnotu parametru. Parametry bez hodnot jsou parametry přepínače. Parametry přepínače se používají jako logické hodnoty. Výchozí hodnota $falseje . Při použití parametru přepínače je hodnota nastavena na $true.

Parametr ListImportedGet-Command je například parametr switch. Když použijete parametr ListImported , rutina vrátí pouze příkazy importované z modulů v aktuální relaci.
```
Get-Command [-ListImported]
```

Závorky [ ] kolem parametrů označují volitelné položky. Parametr a jeho hodnota mohou být volitelné. Například parametr CommandType hodnoty Get-Command a jeho hodnoty jsou uzavřeny v hranatých závorkách, protože oba jsou volitelné.
```
Get-Command [-CommandType <CommandTypes>]
```
Hranaté závorky kolem názvu parametru, ale ne hodnota parametru, značí, že název parametru je volitelný. Tyto parametry se označují jako poziční parametry. Hodnoty parametrů musí být uvedeny ve správném pořadí, aby byly hodnoty vázány na správný parametr.

Například pro rutinu New-Aliasjsou požadovány hodnoty parametrů Name a Value , ale názvy -Name parametrů a , -Valuejsou volitelné.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias MyAlias mycommand.exe
```
V každé sadě parametrů se parametry zobrazí v pořadí pozice. Pořadí parametrů v příkazu záleží jenom v případě, že vynecháte volitelné názvy parametrů. Pokud názvy parametrů vynecháte, PowerShell přiřadí hodnoty parametrům podle pozice a typu. Další informace o pozici parametru najdete v tématu about_Parameters.
Složené závorky {} označují "výčet", což je sada platných hodnot pro parametr.

Hodnoty ve složených závorkách jsou odděleny svislými pruhy |. Tyto pruhy označují výhradní volbu OR , což znamená, že můžete vybrat pouze jednu hodnotu ze sady hodnot, které jsou uvedeny uvnitř složených závorek.

Například syntaxe rutiny New-Alias obsahuje následující výčet hodnot pro parametr Option :
```
New-Alias -Option {None | ReadOnly | Constant | Private | AllScope}
```
Složené závorky a svislé pruhy označují, že můžete zvolit některou z uvedených hodnot parametru Option , například ReadOnly nebo AllScope.
```
New-Alias -Option ReadOnly
```