Aracılığıyla paylaş


about_Command_Syntax

Kısa açıklama

PowerShell'de kullanılan söz dizimi diyagramlarını açıklar.

Uzun açıklama

Get-Help ve Get-Command cmdlet'leri, komutları doğru oluşturmanıza yardımcı olmak için söz dizimi diyagramlarını görüntüler. Bu makalede söz dizimi diyagramlarının nasıl yorumladığı açıklanmaktadır.

Komutun söz dizimini alma

Bir komutun söz dizimini almanın iki yolu vardır: Get-Help ve Get-Command.

Get-Command

Get-Command komutu, sisteminizdeki herhangi bir komut hakkında bilgi almak için kullanılabilir. Bir komutun söz dizimini almak için Sözdizimi parametresini kullanın.

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

Get-Help komutu, söz dizimi, cmdlet ve parametrelerin ayrıntılı açıklaması ve örnekler de dahil olmak üzere PowerShell komutları hakkında ayrıntılı bilgi sağlar. Output Get-Help komutu, komutun kısa bir açıklaması ve ardından söz dizimi ile başlar.

Get-Help Get-Command

Aşağıdaki çıkış, söz dizimi açıklamasına odaklanacak şekilde kısaltılmıştır.

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

Get-Help çıkışı, Get-Commandçıktısından biraz farklıdır. CommandType parametresinin söz dizimindeki farka dikkat edin. Get-Command parametre türünü [CommandTypes] sabit listesi olarak gösterirken, Get-Help numaralandırma için olası değerleri gösterir.

Parametre kümeleri

PowerShell komutunun parametreleri parametre kümelerinde listelenir. PowerShell komutunun bir veya daha fazla parametre kümesi olabilir. Get-Command cmdlet'i, önceki örneklerde gösterildiği gibi iki parametre kümesine sahiptir.

Cmdlet parametrelerinden bazıları bir parametre kümesine özeldir ve diğerleri birden çok parametre kümesinde görünür. Her parametre kümesi geçerli bir komutun biçimini temsil eder. Parametre kümesi yalnızca komutta birlikte kullanılabilen parametreleri içerir. Parametreler aynı komutta kullanılamadığında, ayrı parametre kümelerinde listelenir.

Örneğin, Get-Random cmdlet'inin aşağıdaki parametre kümeleri vardır:

$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>]
  • İlk parametre kümesi bir veya daha fazla rastgele sayı döndürür ve Minimum, En Fazlave Sayısı parametrelerine sahiptir.
  • İkinci parametre kümesi, bir nesne kümesinden rastgele seçilen bir nesne döndürür ve InputObject ve Count parametrelerini içerir.
  • Üçüncü parametre kümesinde, bir kart destesini karıştırma gibi rastgele sırada bir nesne koleksiyonu döndüren Karıştırma parametresi vardır.
  • Tüm parametre kümeleri SetSeed parametresine ve ortak parametrelere sahiptir.

Bu parametre kümeleri, InputObject ve Count parametrelerini aynı komutta kullanabileceğinizi gösterir, ancak Maksimum ve karıştırma parametrelerini birlikte.

Her cmdlet'in varsayılan parametre kümesi de vardır. Varsayılan parametre kümesi, bir parametre kümesine özgü parametreler belirtmediğinizde kullanılır. Örneğin, Get-Random parametresiz kullanıyorsanız PowerShell, RandomNumberParameterSet parametre kümesini kullandığınızı varsayar ve rastgele bir sayı döndürür.

Söz dizimi diyagramlarındaki simgeler

Söz dizimi diyagramında komut adı, komut parametreleri ve parametre değerleri listelenir.

Söz dizimi diyagramları aşağıdaki simgeleri kullanır:

  • Kısa çizgi - parametre adını gösterir. Bir komutta, söz dizimi diyagramında gösterildiği gibi, parametre adından hemen önce, araya boşluk eklemeden kısa çizgi yazın.

    Örneğin, Get-Command parametresini kullanmak için şunu yazın: Get-Command -Name.

  • Köşeli ayraçlar < > yer tutucu metni gösterir. Bir komutta açılı ayraçları veya yer tutucu metni yazmazsınız. Bunun yerine, bunu tanımladığı öğeyle değiştirirsiniz.

    Köşeli ayraçların içindeki yer tutucu, parametrenin aldığı değerin .NET türünü tanımlar. Örneğin, cmdlet'in Get-Command parametresini kullanmak için, <string[]> virgülle ayrılmış bir veya daha fazla dizeyle değiştirirsiniz (,).

  • .NET türüne eklenen köşeli ayraçlar [], parametrenin bu türdeki bir veya daha fazla değeri kabulebileceğini gösterir. Değerleri virgülle ayrılmış liste olarak girin.

    Örneğin, cmdlet'in Adı ve New-Alias parametreleri her biri yalnızca bir dize alır.

    New-Alias [-Name] <string> [-Value] <string>
    
    New-Alias -Name MyAlias -Value mycommand.exe
    

    Ancak get-ProcessName parametresi bir veya daha fazla dize alabilir.

    Get-Process [-Name] <string[]>
    
    Get-Process -Name Explorer, Winlogon, Services
    
  • Değer içermeyen parametreler

    Bazı parametreler girişi kabul etmediğinden parametre değeri yoktur. Değerleri olmayan parametreler, anahtar parametreleri. Anahtar parametreleri boole değerleri gibi kullanılır. Varsayılan olarak $false. Switch parametresi kullandığınızda, değeri $trueolarak ayarlanır.

    Örneğin, Get-Command parametresi bir switch parametresidir. ListImported parametresini kullandığınızda, cmdlet yalnızca geçerli oturumdaki modüllerden içeri aktarılan komutları döndürür.

    Get-Command [-ListImported]
    
  • Parametreler etrafında [ ] köşeli ayraçlar isteğe bağlı öğeleri gösterir. Parametre ve değeri isteğe bağlı olabilir. Örneğin, ve değerinin Get-Command parametresi, her ikisi de isteğe bağlı olduğundan köşeli ayraç içine alınır.

    Get-Command [-CommandType <CommandTypes>]
    

    Parametre adının etrafındaki köşeli ayraçlar parametre değerinin değil, parametre adının isteğe bağlı olduğunu gösterir. Bu parametreler konumsal parametreler olarak bilinir. Değerlerin doğru parametreye bağlanması için parametre değerlerinin doğru sırada sunulması gerekir.

    Örneğin, New-Alias cmdlet'i için Adı ve Değeri parametre değerleri gereklidir, ancak parametre adları, -Name ve -Valueisteğe bağlıdır.

    New-Alias [-Name] <string> [-Value] <string>
    
    New-Alias MyAlias mycommand.exe
    

    Her parametre kümesinde, parametreler konum sırasına göre görüntülenir. Komuttaki parametrelerin sırası yalnızca isteğe bağlı parametre adlarını atladığınızda önemlidir. Parametre adları atlandığında, PowerShell parametrelere konuma ve türe göre değerler atar. Parametre konumu hakkında daha fazla bilgi için bkz. about_Parameters.

  • Ayraçlar {} bir parametre için geçerli değerler kümesi olan "numaralandırmayı" gösterir.

    Küme ayraçlarındaki değerler |dikey çubuklarla ayrılır. Bu çubuklar, özel VEYA seçeneğini gösterir; başka bir deyişle, küme ayraçlarının içinde listelenen değer kümesinden yalnızca bir değer seçebilirsiniz.

    Örneğin, New-Alias cmdlet'inin söz dizimi, Option parametresi için aşağıdaki değer numaralandırmasını içerir:

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

    Ayraçlar ve dikey çubuklar, veya ReadOnlygibi AllScope parametresi için listelenen değerlerden herhangi birini seçebileceğinizi gösterir.

    New-Alias -Option ReadOnly
    

Ayrıca bakınız