about_Command_Syntax

Rövid leírás

A PowerShellben használt szintaxisdiagramokat ismerteti.

Hosszú leírás

A Get-Help és Get-Command parancsmagok szintaxisdiagramokat jelenítenek meg a parancsok helyes létrehozásához. Ez a cikk a szintaxisdiagramok értelmezését ismerteti.

Parancs szintaxisának lekérése

A parancsok szintaxisát kétféleképpen lehet lekérni: Get-Help és Get-Command.

Get-Command

A Get-Command paranccsal információkat kaphat a rendszer bármely parancsáról. A parancs szintaxisának lekéréséhez használja a Szintaxis paramétert.

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

A Get-Help parancs részletes információkat nyújt a PowerShell-parancsokról, beleértve a szintaxist, a parancsmag részletes leírását és paramétereit, valamint példákat. A kimeneti Get-Help parancs a parancs rövid leírásával, majd a szintaxissal kezdődik.

Get-Help Get-Command

A következő kimenet a szintaxis leírására való összpontosítás érdekében rövidült.

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

A Get-Help kimenete kissé eltér a Get-Commandkimenetétől. Figyelje meg a CommandType paraméter szintaxisának különbségét. Get-Command a paramétertípust [CommandTypes] enumerálásként jeleníti meg, míg Get-Help az enumerálás lehetséges értékeit.

Paraméterkészletek

A PowerShell-parancs paraméterei a paraméterkészletekben vannak felsorolva. A PowerShell-parancsok egy vagy több paraméterkészlettel is rendelkezhetnek. A Get-Command parancsmag két paraméterkészlettel rendelkezik, ahogyan az előző példákban is látható.

A parancsmag egyes paraméterei egyediek egy paraméterkészletben, mások pedig több paraméterkészletben jelennek meg. Minden paraméterkészlet egy érvényes parancs formátumát jelöli. A paraméterkészletek csak olyan paramétereket tartalmaznak, amelyek együtt használhatók egy parancsban. Ha a paraméterek nem használhatók ugyanabban a parancsban, külön paraméterkészletekben jelennek meg.

A Get-Random parancsmag például a következő paraméterkészletekkel rendelkezik:

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

Az első paraméterkészlet egy vagy több véletlenszerű számot ad vissza, és a Minimális, Maximálisés Darabszám paraméterekkel rendelkezik.
A második paraméterkészlet egy véletlenszerűen kiválasztott objektumot ad vissza egy objektumkészletből, és tartalmazza a InputObject és Count paramétereket.
A harmadik paraméterkészlet az Shuffle paraméterrel rendelkezik, amely véletlenszerű sorrendben ad vissza egy objektumgyűjteményt, például egy kártyacsomagot.
Minden paraméterkészlet rendelkezik a SetSeed paraméterével és a gyakori paraméterekkel.

Ezek a paraméterkészletek azt mutatják, hogy az InputObject és Count paramétereket használhatja ugyanabban a parancsban, de a Maximális és paraméterek együttes használata nem lehetséges.

Minden parancsmaghoz tartozik egy alapértelmezett paraméterkészlet is. Az alapértelmezett paraméterkészlet akkor használatos, ha nem ad meg olyan paramétereket, amelyek egyediek egy paraméterkészlethez. Ha például Get-Random használ paraméterek nélkül, a PowerShell feltételezi, hogy a RandomNumberParameterSet paraméterkészletet használja, és véletlenszerű számot ad vissza.

Szimbólumok szintaxisdiagramokban

A szintaxisdiagram a parancs nevét, a parancsparamétereket és a paraméterértékeket sorolja fel.

A szintaxisdiagramok a következő szimbólumokat használják:

A kötőjel - paraméternevet jelez. Egy parancsba írja be a kötőjelet közvetlenül a paraméter neve elé beavatkozó szóközök nélkül, ahogy az a szintaxisdiagramon is látható.

Ha például a Get-Command paraméterét szeretné használni, írja be a következőt: Get-Command -Name.

A szögletes zárójelek < > helyőrző szöveget jelölnek. A parancsban nem írja be a szögletes zárójeleket vagy a helyőrző szöveget. Ehelyett az általa leírt elemre cseréli.

A szögletes zárójeleken belüli helyőrző azonosítja a paraméter által használt érték .NET-típusát. Ha például a parancsmag Get-Command paraméterét szeretné használni, a <string[]> egy vagy több vesszővel (,) elválasztott sztringre cseréli.

A .NET-típushoz [] zárójelek azt jelzik, hogy a paraméter elfogadhat egy vagy több ilyen típusú értéket. Adja meg az értékeket vesszővel tagolt listaként.

A Név és paraméterei például csak egy sztringet vesznek fel.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias -Name MyAlias -Value mycommand.exe
```
A Get-ProcessName paramétere azonban egy vagy több sztringet is tartalmazhat.
```
Get-Process [-Name] <string[]>
```
```
Get-Process -Name Explorer, Winlogon, Services
```
Értékek nélküli paraméterek

Egyes paraméterek nem fogadják el a bemenetet, ezért nem rendelkeznek paraméterértékkel. Az értékek nélküli paraméterek kapcsolóparaméterek. A kapcsolóparaméterek a logikai értékekhez hasonlóan használhatók. Alapértelmezés szerint $false. Kapcsolóparaméter használatakor az érték $trueértékre van állítva.

A Get-Command paramétere például egy kapcsolóparaméter. A ListImported paraméter használatakor a parancsmag csak az aktuális munkamenet moduljaiból importált parancsokat adja vissza.
```
Get-Command [-ListImported]
```

A paraméterek köré [ ] zárójelek opcionális elemeket jelölnek. Egy paraméter és annak értéke nem kötelező. A Get-Command paramétere és értéke például szögletes zárójelben van, mert mindkettő nem kötelező.
```
Get-Command [-CommandType <CommandTypes>]
```
A paraméter neve körüli zárójelek, de a paraméter értéke nem azt jelzik, hogy a paraméter neve nem kötelező. Ezeket a paramétereket pozícióparamétereknek nevezzük. A paraméterértékeket a megfelelő sorrendben kell megadni ahhoz, hogy az értékek a megfelelő paraméterhez legyenek kötve.

A New-Alias parancsmag esetében például a Név és Érték paraméterértékek megadása kötelező, de a paraméternevek, -Name és -Valuenem kötelezőek.
```
New-Alias [-Name] <string> [-Value] <string>
```
```
New-Alias MyAlias mycommand.exe
```
Minden paraméterkészletben a paraméterek pozíció sorrendben jelennek meg. A parancs paramétereinek sorrendje csak akkor számít, ha kihagyja az opcionális paraméterneveket. Ha a paraméternevek nincsenek megadva, a PowerShell pozíció és típus szerint rendel értékeket a paraméterekhez. A paraméter helyzetéről további információt a about_Parameters.
A zárójelek {} "számbavételt" jelölnek, amely egy paraméter érvényes értékeinek halmaza.

A kapcsos zárójelek értékeit függőleges sávok választják el |. Ezek a sávok kizárólagos VAGY választást jeleznek, ami azt jelenti, hogy a zárójelek között felsorolt értékek közül csak egy értéket választhat.

A New-Alias parancsmag szintaxisa például a Option paraméter alábbi értékének számbavételét tartalmazza:
```
New-Alias -Option {None | ReadOnly | Constant | Private | AllScope}
```
A kapcsos zárójelek és a függőleges sávok azt jelzik, hogy a Option paraméter felsorolt értékei közül választhat, például ReadOnly vagy AllScope.
```
New-Alias -Option ReadOnly
```

Lásd még

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2025-02-05