about_Command_Syntax

Deskripsi singkat

Menjelaskan diagram sintaks yang digunakan di PowerShell.

Deskripsi panjang

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

DIAGRAM SINTAKS

Setiap paragraf dalam diagram sintaks perintah mewakili bentuk perintah yang valid.

Untuk membuat perintah, ikuti diagram sintaks dari kiri ke kanan. Pilih dari antara parameter opsional dan berikan nilai untuk tempat penampung.

PowerShell menggunakan notasi berikut untuk diagram sintaksis.

<command-name> -<Required Parameter Name> <Required Parameter Value>
[-<Optional Parameter Name> <Optional Parameter Value>]
[-<Optional Switch Parameters>]
[-<Optional Parameter Name>] <Required Parameter Value>

Berikut ini adalah sintaks untuk cmdlet New-Alias .

New-Alias [-Name] <string> [-Value] <string> [-Description <string>]
[-Force] [-Option {None | ReadOnly | Constant | Private | AllScope}]
[-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Sintaksnya dikapitalisasi untuk keterbacaan, tetapi PowerShell tidak peka huruf besar/kecil.

Diagram sintaksis memiliki elemen berikut.

Nama perintah

Perintah selalu dimulai dengan nama perintah, seperti New-Alias. Ketik nama perintah atau aliasnya, seperti "gcm" untuk Get-Command.

Parameter

Parameter perintah adalah opsi yang menentukan apa yang dilakukan perintah. Beberapa parameter mengambil "nilai" yang merupakan input pengguna ke perintah .

Misalnya, Get-Help perintah memiliki parameter Nama yang memungkinkan Anda menentukan nama topik yang bantuannya ditampilkan. Nama topik adalah nilai parameter Nama .

Dalam perintah PowerShell, nama parameter selalu dimulai dengan tanda hubung. Tanda hubung memberi tahu PowerShell bahwa item dalam perintah adalah nama parameter.

Misalnya, untuk menggunakan parameter New-AliasNama , Anda mengetikkan yang berikut ini:

-Name

Parameter dapat bersifat wajib atau opsional. Dalam diagram sintaksis, item opsional diapit dalam tanda kurung [ ].

Untuk informasi selengkapnya tentang parameter, lihat about_Parameters.

Nilai Parameter

Nilai parameter adalah input yang diambil parameter. Karena Windows PowerShell didasarkan pada .NET Framework Microsoft, nilai parameter diwakili dalam diagram sintaks dengan jenis .NET-nya.

Misalnya, parameter Get-Help Nama mengambil nilai "String", yang merupakan string teks, seperti satu kata atau beberapa kata yang diapit dalam tanda kutip.

[-Name] <string>

Jenis .NET dari nilai parameter diapit dalam tanda kurung < > sudut untuk menunjukkan bahwa itu adalah tempat penampung untuk nilai dan bukan harfiah yang Anda ketikkan dalam perintah.

Untuk menggunakan parameter , ganti tempat penampung jenis .NET dengan objek yang memiliki jenis .NET yang ditentukan.

Misalnya, untuk menggunakan parameter Nama , ketik "-Name" diikuti dengan string, seperti berikut ini:

-Name MyAlias

Parameter tanpa nilai

Beberapa parameter tidak menerima input, sehingga tidak memiliki nilai parameter. Parameter tanpa nilai disebut "beralih parameter" karena berfungsi seperti sakelar aktif/nonaktif. Anda menyertakannya (aktif) atau Anda menghilangkannya (nonaktif) dari perintah.

Untuk menggunakan parameter sakelar, cukup ketik nama parameter, yang didahului oleh tanda hubung.

Misalnya, untuk menggunakan parameter WhatIf dari New-Alias cmdlet, ketik yang berikut ini:

-WhatIf

Set Parameter

Parameter perintah tercantum dalam set parameter. Set parameter terlihat seperti paragraf diagram sintaksis.

New-Alias Cmdlet memiliki satu set parameter, tetapi banyak cmdlet memiliki beberapa set parameter. Beberapa parameter cmdlet unik untuk set parameter, dan yang lain muncul dalam beberapa set parameter. Setiap set parameter mewakili format perintah yang valid. Kumpulan parameter hanya menyertakan parameter yang dapat digunakan bersama-sama dalam perintah. Jika parameter tidak dapat digunakan dalam perintah yang sama, parameter tersebut muncul dalam set parameter terpisah.

Misalnya, cmdlet Get-Random memiliki set parameter berikut:

Get-Random [[-Maximum] <Object>] [-Minimum <Object>] [-SetSeed <int>]
[<CommonParameters>]

Get-Random [-InputObject] <Object[]> [-Count <int>] [-SetSeed <int>]
[<CommonParameters>]

Set parameter pertama, yang mengembalikan angka acak, memiliki parameter Minimum dan Maksimum . Kumpulan parameter kedua, yang mengembalikan objek yang dipilih secara acak dari sekumpulan objek, termasuk parameter InputObject dan Count . Kedua set parameter memiliki parameter SetSeed dan parameter 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 Hitung dalam perintah yang sama.

Anda menunjukkan set parameter mana yang ingin Anda gunakan dengan menggunakan parameter dalam kumpulan parameter tersebut.

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

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.

Simbol dalam Diagram Sintaks

Diagram sintaks mencantumkan nama perintah, parameter perintah, dan nilai parameter. Ini juga menggunakan simbol untuk menunjukkan cara membuat perintah yang valid.

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 , New-Aliasketik:

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

    Kurung sudut digunakan untuk mengidentifikasi jenis .NET dari nilai yang diambil parameter. Misalnya, untuk menggunakan parameter New-AliasNama cmdlet, Anda mengganti <string> dengan string, yang merupakan satu kata atau sekelompok kata yang diapit dalam tanda kutip.

  • Tanda kurung [ ] menunjukkan item opsional. Parameter dan nilainya dapat bersifat opsional, atau nama parameter yang diperlukan dapat bersifat opsional.

    Misalnya, parameter Deskripsi dan New-Alias nilainya diapit dalam tanda kurung siku karena keduanya opsional.

    [-Description <string>]
    

    Tanda kurung siku juga menunjukkan bahwa nilai <string> parameter Nama diperlukan, tetapi nama parameter, "Nama", bersifat opsional.

    [-Name] <string>
    
  • Tanda kurung [] kanan dan kiri yang ditambahkan ke jenis .NET menunjukkan bahwa parameter dapat menerima satu atau beberapa nilai dari jenis tersebut. Masukkan nilai dalam daftar yang dipisahkan koma.

    Misalnya, parameter New-AliasNama cmdlet hanya mengambil satu string, tetapi parameter NamaGet-Process dapat mengambil satu atau banyak string.

    New-Alias [-Name] <string>
    
    New-Alias -Name MyAlias
    
    Get-Process [-Name] <string[]>
    
    Get-Process -Name Explorer, Winlogon, Services
    
  • Kurung {} kurawal menunjukkan "enumerasi," yang merupakan sekumpulan nilai yang valid untuk parameter.

    Nilai dalam kurung kurawal dipisahkan |oleh bilah vertikal . Bilah ini menunjukkan pilihan "EKSKLUSIF ATAU", yang berarti Anda hanya dapat memilih satu nilai dari kumpulan nilai yang tercantum di dalam kurung kurawal.

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

    -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 "ReadOnly" atau "AllScope".

    -Option ReadOnly
    

Item Opsional

Kurung [] siku mengelilingi item opsional. Misalnya, dalam New-Alias deskripsi sintaks cmdlet, parameter Cakupan bersifat opsional. Ini ditunjukkan dalam sintaks dengan tanda kurung di sekitar nama dan jenis parameter:

[-Scope <string>]

Kedua contoh berikut adalah penggunaan cmdlet yang New-Alias benar:

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd -Value Update-TypeData -Scope Global

Nama parameter dapat bersifat opsional meskipun nilai untuk parameter tersebut diperlukan. Ini ditunjukkan dalam sintaks dengan tanda kurung di sekitar nama parameter tetapi bukan jenis parameter, seperti dalam contoh ini dari New-Alias cmdlet:

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

Perintah berikut menggunakan cmdlet dengan benar New-Alias . Perintah menghasilkan hasil yang sama.

New-Alias -Name utd -Value Update-TypeData
New-Alias -Name utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData

Jika nama parameter tidak disertakan dalam pernyataan seperti yang di ketik, Windows PowerShell mencoba menggunakan posisi argumen untuk menetapkan nilai ke parameter.

Contoh berikut tidak lengkap:

New-Alias utd

Cmdlet ini memerlukan nilai untuk parameter Nama dan Nilai .

Dalam contoh sintaks, tanda kurung juga digunakan dalam penamaan dan transmisi ke jenis .NET Framework. Dalam konteks ini, tanda kurung siku tidak menunjukkan elemen bersifat opsional.

Lihat juga