Cmdlet Öznitelik Bildirimi

Cmdlet özniteliği, bir Microsoft .NET Framework sınıfını bir cmdlet olarak tanımlar ve cmdlet'i çağırmak için kullanılan fiili ve ismi belirtir.

Sözdizimi

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

Parametreler

FiilAdı (System.String) Gerekli. Cmdlet fiilini belirtir. Bu fiil cmdlet'in gerçekleştirdiği eylemi belirtir. Onaylanan cmdlet fiilleri hakkında daha fazla bilgi için bkz. Cmdlet Fiil Adları ve Gerekli Geliştirme Yönergeleri.

NounName (System.String) Gerekli. Cmdlet adını belirtir. Bu isim cmdlet'in üzerinde işlem yaptığı kaynağı belirtir. Cmdlet adları hakkında daha fazla bilgi için bkz. Cmdlet Bildirimi ve Kesinlikle Teşvik Edilen Geliştirme Yönergeleri.

SupportsShouldProcess (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, cmdlet'in System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan çağrıları desteklediğini belirtir; bu, cmdlet'e, sistemi değiştiren bir eylem gerçekleştirilmeden önce kullanıcıya bilgi verme yolu sağlar. Varsayılan değer olan False, cmdlet'in System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan çağrıları desteklemediğini belirtir. Onay istekleri hakkında daha fazla bilgi için bkz. Onay İsteme.

ConfirmImpact (System.Management.Automation.Confirmimpact) İsteğe bağlı adlandırılmış parametre. Cmdlet eyleminin System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan bir çağrı tarafından ne zaman onaylanması gerektiğini belirtir. System.Management.Automation.Cmdlet.ShouldProcess yalnızca cmdlet'in ConfirmImpact değeri (varsayılan olarak Medium) $ConfirmPreference değişkeninin değerine eşit veya ondan büyük olduğunda çağrılır. Bu parametre yalnızca SupportsShouldProcess parametresi belirtildiğinde belirtilmelidir.

DefaultParameterSetName (System.String) İsteğe bağlı adlandırılmış parametre. Windows PowerShell çalışma zamanının hangi parametre kümesinin kullanılacağını belirleyemediği durumlarda kullanmaya çalıştığı varsayılan parametre kümesini belirtir. Her parametre setinin benzersiz parametresinin zorunlu parametre haline getirilmesiyle bu durumun ortadan kaldırılabileceğine dikkat edin.

Varsayılan bir parametre kümesi adı belirtilse bile Windows PowerShell'in varsayılan parametre kümesini kullanamadığı bir durum vardır. Windows PowerShell çalışma zamanı, yalnızca nesne türüne dayalı parametre kümeleri arasında ayrım yapamaz. Örneğin, dosya yolu olarak bir dize alan bir parametre kümeniz ve doğrudan FileInfo nesnesini alan başka bir kümeniz varsa, Windows PowerShell, iletilen değerlere göre hangi parametre kümesinin kullanılacağını belirleyemez. cmdlet'i kullanmaz ve varsayılan parametre kümesini kullanmaz. Bu durumda, varsayılan bir parametre kümesi adı belirtseniz bile, Windows PowerShell belirsiz bir parametre kümesi hata iletisi atar.

SupportsTransactions (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet'in bir işlem içinde kullanılabileceğini belirtir. True belirtildiğinde, Windows PowerShell çalışma zamanı UseTransaction parametresini cmdlet'in parametre listesine ekler. Varsayılan değer olan False, cmdlet'in bir işlem içinde kullanılamayacağını belirtir.

Notlar

Fiil ve isim birlikte kayıtlı cmdlet'inizi tanımlamak ve cmdlet'inizi bir komut dosyası içinde çağırmak için kullanılır.
Cmdlet Windows PowerShell konsolundan çağrıldığında komut aşağıdaki komuta benzer:

FiilAdı-İsimAdı

Windows PowerShell dışındaki kaynakları değiştiren tüm cmdlet'ler, Cmdlet özniteliği bildirildiğinde SupportsShouldProcess anahtar sözcüğünü içermelidir; bu, cmdlet'in, cmdlet görevini gerçekleştirmeden önce System.Management.Automation.Cmdlet.ShouldProcess yöntemini çağırmasına olanak tanır. aksiyon. System.Management.Automation.Cmdlet.ShouldProcess çağrısı false değerini döndürürse eylem gerçekleştirilmemelidir. System.Management.Automation.Cmdlet.ShouldProcess çağrısı tarafından oluşturulan onay istekleri hakkında daha fazla bilgi için bkz. Onay İsteme.

Confirm ve WhatIf cmdlet parametreleri yalnızca System.Management.Automation.Cmdlet.ShouldProcess çağrılarını destekleyen cmdlet'ler için kullanılabilir.

Örnek

Aşağıdaki sınıf tanımı, yerel bilgisayarda çalışan işlemler hakkında bilgi alan bir Get-Proc cmdlet'i için .NET Framework sınıfını tanımlamak üzere Cmdlet özniteliğini kullanır.

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

Get-Proc cmdlet'i hakkında daha fazla bilgi için GetProc Eğitimi'ne bakın.

Ayrıca Bakınız