Bagikan melalui

tentang Command Syntax

Deskripsi singkat

Menjelaskan diagram sintaksis yang digunakan di PowerShell.

Deskripsi panjang

Cmdlet Get-Help dan Get-Command menampilkan diagram sintaks untuk membantu Anda membuat perintah dengan benar. Artikel ini menjelaskan cara menginterpretasikan diagram sintaks.

Mendapatkan sintaks untuk perintah

Ada dua cara untuk mendapatkan sintaks untuk perintah: Get-Help dan Get-Command.

Get-Command

Perintah Get-Command dapat digunakan untuk mendapatkan informasi tentang perintah apa pun di sistem Anda. Gunakan parameter Sintaks untuk mendapatkan sintaks untuk perintah.

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

Perintah Get-Help menyediakan informasi terperinci tentang perintah PowerShell termasuk, sintaksis, deskripsi terperinci tentang cmdlet dan parameter, dan contoh. Perintah output Get-Help dimulai dengan deskripsi singkat perintah diikuti dengan sintaks.

Get-Help Get-Command

Output berikut telah dipersingkat untuk fokus pada deskripsi sintaks.

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

Output Get-Help sedikit berbeda dari output Get-Command. Perhatikan perbedaan dalam sintaks untuk parameter CommandType. Get-Command menunjukkan jenis parameter sebagai enumerasi [CommandTypes], sementara Get-Help menunjukkan nilai yang mungkin untuk enumerasi.

Kumpulan Parameter

Parameter perintah PowerShell tercantum dalam set parameter. Perintah PowerShell dapat memiliki satu atau beberapa set parameter. Cmdlet Get-Command memiliki dua set parameter, seperti yang ditunjukkan pada contoh sebelumnya.

Beberapa parameter cmdlet unik pada sebuah set parameter, dan yang lain muncul dalam beberapa set parameter lainnya. Setiap set parameter mewakili format untuk perintah yang valid. Set parameter hanya mencakup parameter yang dapat digunakan bersama-sama dalam perintah. Saat parameter tidak dapat digunakan dalam perintah yang sama, parameter tersebut tercantum dalam set parameter terpisah.

Misalnya, cmdlet Get-Random memiliki set parameter berikut:

$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>]
  • Set parameter pertama mengembalikan satu atau beberapa angka acak dan memiliki parameter Minimum, Maksimum, dan Hitungan.
  • Set parameter kedua mengembalikan objek yang dipilih secara acak dari sekumpulan objek dan menyertakan parameter InputObject dan Count.
  • Set parameter ketiga memiliki parameter Shuffle yang mengembalikan kumpulan objek dalam urutan acak, seperti mengacak dek kartu.
  • Semua set parameter memiliki parameter SetSeed dan parameter yang umum.

Kumpulan parameter ini menunjukkan bahwa Anda dapat menggunakan parameter InputObject dan Count dalam perintah yang sama, tetapi Anda tidak dapat menggunakan parameter Maksimum dan Acak bersama-sama.

Setiap cmdlet juga memiliki parameter bawaan. Set parameter default digunakan saat Anda tidak menentukan parameter yang unik untuk kumpulan parameter. Misalnya, jika Anda menggunakan Get-Random tanpa parameter, PowerShell mengasumsikan bahwa Anda menggunakan set parameter RandomNumberParameterSet dan mengembalikan angka acak.

Simbol dalam diagram sintaks

Diagram sintaks mencantumkan nama perintah, parameter perintah, dan nilai parameter.

Diagram sintaks menggunakan simbol berikut:

  • Tanda hubung - menunjukkan nama parameter. Dalam perintah, ketik tanda hubung segera sebelum nama parameter tanpa spasi intervensi, seperti yang ditunjukkan dalam diagram sintaks.

    Misalnya, untuk menggunakan parameter Nama dari , ketik: .

  • Kurung sudut < > menunjukkan teks pengganti. Anda tidak mengetik tanda kurung sudut atau teks tempat penampung dalam perintah. Sebagai gantinya, Anda menggantinya dengan item yang dijelaskannya.

    Penanda di dalam kurung sudut mengidentifikasi jenis .NET dari nilai yang dimiliki oleh parameter. Misalnya, untuk menggunakan parameter Nama dari cmdlet Get-Command, Anda mengganti <string[]> dengan satu atau beberapa string yang dipisahkan oleh koma (,).

  • Tanda kurung [] ditambahkan ke jenis .NET menunjukkan bahwa parameter dapat menerima satu atau beberapa nilai dari jenis tersebut. Masukkan nilai sebagai daftar yang dipisahkan koma.

    Misalnya, parameter Nama dan Nilai dari cmdlet New-Alias hanya mengambil masing-masing satu string.

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

    New-Alias -Name MyAlias -Value mycommand.exe

    Tetapi parameter Name dari Get-Process dapat mengambil satu atau beberapa string.

    Get-Process [-Name] <string[]>

    Get-Process -Name Explorer, Winlogon, Services

  • Parameter tanpa nilai

    Beberapa parameter tidak menerima input, sehingga tidak memiliki nilai parameter. Parameter yang tidak memiliki nilai adalah parameter sakelar . Parameter switch digunakan seperti nilai boolean. Pengaturan otomatisnya ke $false. Saat Anda menggunakan parameter pengalihan, nilai diatur ke $true.

    Misalnya, parameter ListImported dari Get-Command adalah parameter saklar. Saat Anda menggunakan parameter ListImported, cmdlet hanya mengembalikan perintah yang diimpor dari modul dalam sesi saat ini.

    Get-Command [-ListImported]

  • Tanda kurung [ ] di sekitar parameter menunjukkan item opsional. Parameter dan nilainya bisa bersifat opsional. Misalnya, parameter CommandType dari Get-Command dan nilainya diapit dalam tanda kurung karena keduanya bersifat opsional.

    Get-Command [-CommandType <CommandTypes>]

    Tanda kurung di sekitar nama parameter, tetapi bukan nilai parameter, menunjukkan bahwa nama parameter bersifat opsional. Parameter ini dikenal sebagai parameter posisi. Nilai parameter harus disajikan dalam urutan yang benar agar nilai terikat ke parameter yang benar.

    Misalnya, untuk cmdlet , nilai parameter Nama dan Nilai diperlukan, tetapi nama parameter, dan , bersifat opsional.

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

    New-Alias MyAlias mycommand.exe

    Di setiap set parameter, parameter muncul dalam urutan posisi. Urutan parameter dalam perintah hanya penting saat Anda menghilangkan nama parameter opsional. Saat nama parameter dihilangkan, PowerShell menetapkan nilai ke parameter berdasarkan posisi dan jenis. Untuk informasi selengkapnya tentang posisi parameter, lihat about_Parameters.

  • Kurung kurawal {} menunjukkan "enumerasi," yaitu sekumpulan nilai yang valid untuk parameter.

    Nilai dalam kurung kurawal dipisahkan oleh garis vertikal |. Bilah ini menunjukkan pilihan eksklusif-ATAU, yang berarti bahwa Anda hanya dapat memilih satu nilai dari kumpulan nilai yang tercantum di dalam kurung kurawal.

    Misalnya, sintaks untuk cmdlet menyertakan enumerasi nilai berikut untuk parameter Opsi :

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

    Kurung kurawal dan bilah vertikal menunjukkan bahwa Anda dapat memilih salah satu nilai yang tercantum untuk parameter Opsi , seperti atau .

    New-Alias -Option ReadOnly

Lihat juga

  • Last updated on