Cmdlet Özniteliği Bildirimi

  • Makale

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

Sözdizimi

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

Parametreler

VerbName (System.String) Gerekli. cmdlet fiilini belirtir. Bu fiil, cmdlet tarafından yapılan eylemi belirtir. Onaylı cmdlet fiilleri hakkında daha fazla bilgi için bkz. Cmdlet Fiil Adları ve Gerekli Geliştirme Yönergeleri.

NounName (System.String) Gerekli. Cmdlet'ini belirtir. Bu noun, cmdlet'in üzerinde eylemde olduğu kaynağı belirtir. cmdlet'leri hakkında daha fazla bilgi için bkz. Cmdlet Bildirimi ve Kesinlikle Teşvik Edilecek Geliştirme Yönergeleri.

SupportsShouldProcess (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet'inin System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan çağrıları desteklediğini gösterir. Bu yöntem, cmdlet'in sistemi değiştirirken kullanıcıya bir komut istemi göndermesi için bir yol sağlar. False, varsayılan değer, cmdlet'in System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan çağrıları desteklemediğini gösterir. Onay istekleri hakkında daha fazla bilgi için bkz. Onay İsteği.

ConfirmImpact (System.Management.Automation.Confirmimpact) İsteğe bağlı adlandırılmış parametre. Cmdlet'in eyleminin System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan bir çağrı tarafından ne zaman onaylanır olduğunu belirtir. System.Management.Automation.Cmdlet.ShouldProcess yalnızca cmdlet'in ConfirmImpact değeri değişkenin değerine eşit veya daha büyük olduğunda $ConfirmPreference çağrılır. Bu parametre yalnızca parametresi SupportsShouldProcess belirtilirken belirtilmelidir.

DefaultParameterSetName (System.String) İsteğe bağlı adlandırılmış parametre. Çalışma zamanının hangi parametre kümesi Windows PowerShell için kullanmayı denemesi varsayılan parametre kümesi belirtir. Her parametrenin benzersiz parametresi zorunlu bir parametre ayararak bu durumun ortadan kaldırılmış olduğunu fark etmek.

Varsayılan parametre kümesi adı Windows PowerShell bile varsayılan parametre kümesi kullanılamaz. Çalışma Windows PowerShell, parametre kümelerini yalnızca nesne türüne göre ayırt etmek için kullanılamaz. Örneğin, dosya yolu olarak bir dize alan bir parametre kümeniz ve bir FileInfo nesnesini doğrudan alan başka bir kümeniz varsa, Windows PowerShell cmdlet'e geçirilen değerlere göre hangi parametre kümesi kullanmak üzere olduğunu belirleyamaz ve varsayılan parametre kümesi kullanmaz. Bu durumda, varsayılan parametre kümesi adı belirtebilirsiniz, Windows PowerShell bir parametre kümesi hata iletisi verir.

SupportsTransactions (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet'inin bir işlem içinde kullanılal olduğunu gösterir. Belirtilen True zaman, Windows PowerShell çalışma zamanı UseTransaction cmdlet'inin parametre listesine parametresini ekler. False, varsayılan değer, cmdlet'in bir işlem içinde kullanılamay olduğunu gösterir.

Açıklamalar

  • Fiil ve ada birlikte, kayıtlı cmdlet'inizi tanımlamak ve cmdlet'inizi bir betik içinde çağırmak için kullanılır.

  • cmdlet'i Windows PowerShell konsolundan çağrıldığında, komut aşağıdaki komuta benzer:

VerbName-NounName

ve Confirm 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'inin .NET Framework sınıfını tanımlamak için Cmdlet özniteliğini kullanır.

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

Get-Proc cmdlet'i hakkında daha fazla bilgi için bkz. GetProc Öğreticisi.

Ayrıca Bkz.

Windows PowerShell Cmdlet’ini Yazma