Bagikan melalui

Deklarasi Atribut Parameter

Atribut Parameter mengidentifikasi properti publik dari kelas cmdlet sebagai parameter cmdlet.

Sintaksis

[Parameter()]
[Parameter(Named Parameters...)]

Parameter

Mandatory (System.Boolean) Parameter bernama opsional. True menunjukkan parameter cmdlet diperlukan. Jika parameter yang diperlukan tidak disediakan saat cmdlet dipanggil, Windows PowerShell meminta pengguna untuk nilai parameter. Defaultnya adalah false.

ParameterSetName (System.String) Parameter bernama opsional. Menentukan set parameter tempat parameter cmdlet ini berada. Jika tidak ada set parameter yang ditentukan, parameter milik semua set parameter.

Position (System.Int32) Parameter bernama opsional. Menentukan posisi parameter dalam perintah Windows PowerShell.

ValueFromPipeline (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa parameter cmdlet mengambil nilainya dari objek alur. Tentukan kata kunci ini jika cmdlet mengakses objek lengkap, bukan hanya properti objek. Defaultnya adalah false.

ValueFromPipelineByPropertyName (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa parameter cmdlet mengambil nilainya dari properti objek alur yang memiliki nama yang sama atau alias yang sama dengan parameter ini. Misalnya, jika cmdlet memiliki parameter Name dan objek alur juga memiliki properti Name, nilai properti Name ditetapkan ke parameter Name cmdlet. Defaultnya adalah false.

ValueFromRemainingArguments (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa parameter cmdlet menerima semua argumen tersisa yang diteruskan ke cmdlet. Defaultnya adalah false.

HelpMessage (System.String) Parameter bernama opsional. Menentukan deskripsi singkat parameter. Windows PowerShell menampilkan pesan ini ketika cmdlet dijalankan dan parameter wajib tidak ditentukan.

HelpMessageBaseName (System.String) Parameter bernama opsional. Menentukan lokasi tempat pengidentifikasi sumber daya berada. Misalnya, parameter ini dapat menentukan rakitan sumber daya yang berisi pesan Bantuan yang ingin Anda lokalkan.

HelpMessageResourceId (System.String) Parameter bernama opsional. Menentukan pengidentifikasi sumber daya untuk pesan Bantuan.

DontShow (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa parameter disembunyikan dari pengguna untuk ekspansi tab dan IntelliSense. Defaultnya adalah false.

Komentar

  • Untuk informasi selengkapnya tentang cara mendeklarasikan atribut ini, lihat Cara Mendeklarasikan Parameter Cmdlet.

  • Cmdlet dapat memiliki sejumlah parameter. Namun, untuk pengalaman pengguna yang lebih baik, batasi jumlah parameter.

  • Parameter harus dideklarasikan pada bidang atau properti non-statis publik. Parameter harus dideklarasikan pada properti. Properti harus memiliki aksesor set publik, dan jika kata kunci ValueFromPipeline atau ValueFromPipelineByPropertyName ditentukan, properti harus memiliki aksesor get publik.

  • Saat Anda menentukan parameter posisi, batasi jumlah parameter posisi dalam parameter yang diatur ke kurang dari lima. Dan, parameter posisi tidak harus berseberangan. Posisi 5, 100, dan 250 bekerja sama dengan posisi 0, 1, dan 2.

  • Ketika kata kunci Position tidak ditentukan, parameter cmdlet harus dirujuk dengan namanya.

  • Saat Anda menggunakan set parameter, perhatikan hal berikut:

    • Setiap set parameter harus memiliki setidaknya satu parameter unik. Desain cmdlet yang baik menunjukkan parameter unik ini juga harus wajib jika memungkinkan. Jika cmdlet Anda dirancang untuk dijalankan tanpa parameter, parameter unik tidak boleh wajib.

    • Tidak ada set parameter yang harus berisi lebih dari satu parameter posisi dengan posisi yang sama.

    • Hanya satu parameter dalam set parameter yang harus mendeklarasikan ValueFromPipeline = true.

    • Beberapa parameter dapat menentukan ValueFromPipelineByPropertyName = true.

  • Untuk informasi selengkapnya tentang panduan untuk nama parameter, lihat Nama Parameter Cmdlet .

  • Atribut parameter didefinisikan oleh kelas System.Management.Automation.ParameterAttribute.

  • Parameter DontShow memiliki efek samping berikut:

    • Memengaruhi semua set parameter untuk parameter terkait, bahkan jika ada parameter yang diatur di mana DontShow tidak digunakan.
    • Menyembunyikan parameter umum dari penyelesaian tab dan IntelliSense. DontShow tidak menyembunyikan parameter umum opsional: WhatIf, Konfirmasi, atau UseTransaction.

Lihat Juga

  • Last updated on