Aracılığıyla paylaş

Cmdlet Özniteliği Bildirimi

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

Sözdizimi

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

Parametreler

VerbName (System.String) Gerekli. cmdlet fiilini belirtir. Bu fiil, cmdlet'i tarafından gerçekleştirilen 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'ini 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, sistemi değiştiren bir eylem gerçekleştirilmeden önce kullanıcıya sorma yolu sağlayan System.Management.Automation.Cmdlet.ShouldProcess yöntemine yapılan çağrıları desteklediğini gösterir. varsayılan değer olan False, 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 İsteme.

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ıyla ne zaman doğrulanması gerektiğini belirtir. System.Management.Automation.Cmdlet.ShouldProcess yalnızca cmdlet'in ConfirmImpact değeri (varsayılan olarak Orta) $ConfirmPreference değişkeninin değerine eşit veya bundan 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. Hangi parametre kümesinin kullanılacağını belirleyemediğinde Windows PowerShell çalışma zamanının kullanmayı denediği varsayılan parametre kümesini belirtir. Her parametre kümesinin benzersiz parametresi zorunlu bir parametre yapılarak bu durumun ortadan kaldırılabildiğine dikkat edin.

Varsayılan parametre kümesi adı belirtilmiş olsa bile Windows PowerShell'in varsayılan parametre kümesini kullanamadığı bir durum vardır. Windows PowerShell çalışma zamanı, parametre kümelerini yalnızca nesne türüne göre ayırt edemez. Örneğin, bir dizeyi dosya yolu olarak alan bir parametre kümeniz ve doğrudan FileInfo nesnesini alan başka bir kümeniz varsa, Windows PowerShell cmdlet'e geçirilen değerlere göre hangi parametre kümesinin kullanılacağını belirleyemez ve varsayılan parametre kümesini kullanmaz. Bu durumda, varsayılan parametre kümesi adını belirtseniz bile, Windows PowerShell belirsiz bir parametre kümesi hata iletisi oluşturur.

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

Açıklamalar

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

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

VerbName-NounName

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 için Cmdlet özniteliğini kullanır.

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

get-proc cmdlet'ini hakkında daha fazla bilgi için bkz. getproc öğreticisi .

Ayrıca Bkz.

Windows PowerShell Cmdlet'i yazma

  • Last updated on