Deklarasi Atribut Cmdlet

Atribut Cmdlet mengidentifikasi kelas Microsoft .NET Framework sebagai cmdlet dan menentukan kata kerja dan kata benda yang digunakan untuk memanggil cmdlet.

Sintaksis

[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]

Parameter-parameternya

VerbName (System.String) Diperlukan. Menentukan kata kerja cmdlet. Kata kerja ini menentukan tindakan yang diambil oleh cmdlet. Untuk informasi selengkapnya tentang kata kerja cmdlet yang disetujui, lihat Nama Kata Kerja Cmdlet dan Pedoman Pengembangan yang Diperlukan.

NounName (System.String) Diperlukan. Menentukan kata benda cmdlet. Kata benda ini menentukan sumber daya yang ditindaklanjuti cmdlet. Untuk informasi selengkapnya tentang kata benda cmdlet, lihat Deklarasi Cmdlet dan Panduan Pengembangan yang Sangat Didorong .

SupportsShouldProcess (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa cmdlet mendukung panggilan ke metode System.Management.Automation.Cmdlet.ShouldProcess, yang menyediakan cmdlet dengan cara untuk meminta pengguna sebelum tindakan yang mengubah sistem dilakukan. False, nilai default, menunjukkan bahwa cmdlet tidak mendukung panggilan ke metode System.Management.Automation.Cmdlet.ShouldProcess. Untuk informasi selengkapnya tentang permintaan konfirmasi, lihat Meminta Konfirmasi.

ConfirmImpact (System.Management.Automation.ConfirmImpact) Parameter bernama opsional. Menentukan kapan tindakan cmdlet harus dikonfirmasi dengan panggilan ke metode System.Management.Automation.Cmdlet.ShouldProcess. System.Management.Automation.Cmdlet.ShouldProcess hanya akan dipanggil ketika nilai ConfirmImpact cmdlet (secara default, Sedang) sama dengan atau lebih besar dari nilai variabel $ConfirmPreference. Parameter ini harus ditentukan hanya ketika parameter SupportsShouldProcess ditentukan.

DefaultParameterSetName (System.String) Parameter bernama opsional. Menentukan kumpulan parameter default yang coba digunakan runtime Windows PowerShell saat tidak dapat menentukan parameter mana yang diatur untuk digunakan. Perhatikan bahwa situasi ini dapat dihilangkan dengan membuat parameter unik dari setiap parameter yang ditetapkan parameter wajib.

Ada satu kasus di mana Windows PowerShell tidak dapat menggunakan set parameter default meskipun nama set parameter default ditentukan. Runtime Windows PowerShell tidak dapat membedakan antara set parameter hanya berdasarkan jenis objek. Misalnya, jika Anda memiliki satu set parameter yang mengambil string sebagai jalur file, dan set lain yang mengambil objek FileInfo secara langsung, Windows PowerShell tidak dapat menentukan parameter mana yang diatur untuk digunakan berdasarkan nilai yang diteruskan ke cmdlet, juga tidak menggunakan set parameter default. Dalam hal ini, bahkan jika Anda menentukan nama set parameter default, Windows PowerShell melempar pesan kesalahan kumpulan parameter ambigu.

SupportsTransactions (System.Boolean) Parameter bernama opsional. True menunjukkan bahwa cmdlet dapat digunakan dalam transaksi. Saat True ditentukan, runtime Windows PowerShell menambahkan parameter UseTransaction ke daftar parameter cmdlet. False, nilai default, menunjukkan bahwa cmdlet tidak dapat digunakan dalam transaksi.

Komentar

• Bersama-sama, kata kerja dan kata benda digunakan untuk mengidentifikasi cmdlet terdaftar Anda dan untuk memanggil cmdlet Anda dalam skrip.

• Ketika cmdlet dipanggil dari konsol Windows PowerShell, perintah menyerupan perintah berikut:

VerbName-NounName

• Semua cmdlet yang mengubah sumber daya di luar Windows PowerShell harus menyertakan kata kunci SupportsShouldProcess ketika atribut Cmdlet dideklarasikan, yang memungkinkan cmdlet untuk memanggil metode System.Management.Automation.Cmdlet.ShouldProcess sebelum cmdlet melakukan tindakannya. Jika panggilan System.Management.Automation.Cmdlet.ShouldProcess mengembalikan false, tindakan tidak boleh diambil. Untuk informasi selengkapnya tentang permintaan konfirmasi yang dihasilkan oleh panggilan System.Management.Automation.Cmdlet.ShouldProcess, lihat Meminta Konfirmasi.

Parameter cmdlet Confirm dan WhatIf hanya tersedia untuk cmdlet yang mendukung panggilan System.Management.Automation.Cmdlet.ShouldProcess.

Contoh

Definisi kelas berikut menggunakan atribut Cmdlet untuk mengidentifikasi kelas .NET Framework untuk cmdlet Get-Proc yang mengambil informasi tentang proses yang berjalan di komputer lokal.

[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet

Untuk informasi selengkapnya tentang cmdlet Get-Proc, lihat GetProc Tutorial.

Lihat Juga

Menulis Cmdlet Windows PowerShell