Aracılığıyla paylaş

Parametre Öznitelik Bildirimi

Parameter özniteliği, cmdlet sınıfının ortak özelliğini cmdlet parametresi olarak tanımlar.

Sözdizimi

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

Parametre

Mandatory (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet parametresinin gerekli olduğunu gösterir. Cmdlet çağrıldığında gerekli bir parametre sağlanmazsa, Windows PowerShell kullanıcıdan bir parametre değeri ister. Varsayılan değer false.

ParameterSetName (System.String) İsteğe bağlı adlandırılmış parametre. Bu cmdlet parametresinin ait olduğu parametre kümesini belirtir. Parametre kümesi belirtilmezse, parametre tüm parametre kümelerine aittir.

Position (System.Int32) İsteğe bağlı adlandırılmış parametre. Bir Windows PowerShell komutu içinde parametresinin konumunu belirtir.

ValueFromPipeline (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet parametresinin değerini bir işlem hattı nesnesinden aldığını gösterir. Cmdlet yalnızca nesnenin bir özelliğine değil, tam nesneye erişiyorsa bu anahtar sözcüğü belirtin. Varsayılan değer false.

ValueFromPipelineByPropertyName (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, cmdlet parametresinin değerini bu parametreyle aynı ada veya aynı diğer ada sahip bir işlem hattı nesnesinin özelliğinden aldığını gösterir. Örneğin, cmdlet'in bir Name parametresi varsa ve işlem hattı nesnesinin de Name özelliği varsa, Name özelliğinin değeri cmdlet'in Name parametresine atanır. Varsayılan değer false.

ValueFromRemainingArguments (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, cmdlet parametresinin cmdlet'e geçirilen kalan tüm bağımsız değişkenleri kabul ettiğini gösterir. Varsayılan değer false.

HelpMessage (System.String) İsteğe bağlı adlandırılmış parametre. parametresinin kısa bir açıklamasını belirtir. Bir cmdlet çalıştırıldığında ve zorunlu bir parametre belirtilmediğinde Windows PowerShell bu iletiyi görüntüler.

HelpMessageBaseName (System.String) İsteğe bağlı adlandırılmış parametre. Kaynak tanımlayıcılarının bulunduğu konumu belirtir. Örneğin, bu parametre yerelleştirmek istediğiniz Yardım iletilerini içeren bir kaynak derlemesi belirtebilir.

HelpMessageResourceId (System.String) İsteğe bağlı adlandırılmış parametre. Yardım iletisinin kaynak tanımlayıcısını belirtir.

DontShow (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, parametrenin sekme genişletme ve IntelliSense için kullanıcıdan gizlendiğini gösterir. Varsayılan değer false.

Açıklamalar

  • Bu özniteliği bildirme hakkında daha fazla bilgi için bkz. Cmdlet Parametrelerini Bildirme.

  • Cmdlet'in herhangi bir sayıda parametresi olabilir. Ancak, daha iyi bir kullanıcı deneyimi için parametre sayısını sınırlayın.

  • Parametreler, statik olmayan genel alanlarda veya özelliklerde bildirilmelidir. Parametreler özelliklerde bildirilmelidir. Özelliğin bir ortak küme erişimcisi olmalıdır ve ValueFromPipeline veya ValueFromPipelineByPropertyName anahtar sözcüğü belirtilirse özelliğin genel get erişimcisi olmalıdır.

  • Konumsal parametreler belirttiğinizde, bir parametredeki konumsal parametre sayısını beşten az olacak şekilde sınırlayın. Konumsal parametrelerin bitişik olması gerekmez. 5, 100 ve 250 konumları 0, 1 ve 2 konumları ile aynı şekilde çalışır.

  • Position anahtar sözcüğü belirtilmediğinde, cmdlet parametresine adıyla başvurulmalıdır.

  • Parametre kümelerini kullanırken aşağıdakilere dikkat edin:

    • Her parametre kümesinin en az bir benzersiz parametresi olmalıdır. İyi cmdlet tasarımı, mümkünse bu benzersiz parametrenin de zorunlu olması gerektiğini gösterir. Cmdlet'iniz parametresiz çalıştırılacak şekilde tasarlandıysa, benzersiz parametre zorunlu olamaz.

    • Hiçbir parametre kümesi aynı konuma sahip birden fazla konumsal parametre içermemelidir.

    • Bir parametre kümesindeki yalnızca bir parametre ValueFromPipeline = truebildirmelidir.

    • birden çok parametre ValueFromPipelineByPropertyName = truetanımlayabilir.

  • Parametre adları yönergeleri hakkında daha fazla bilgi için bkz. Cmdlet Parametre Adları.

  • parametre özniteliği, System.Management.Automation.ParameterAttribute sınıfı tarafından tanımlanır.

  • DontShow parametresi aşağıdaki yan etkilere sahiptir:

    • DontShow kullanılmadığı bir parametre kümesi olsa bile ilişkili parametre için tüm parametre kümelerini etkiler.
    • Sekme tamamlama ve IntelliSense'ten ortak parametreleri gizler. isteğe bağlı ortak parametreleri gizlemez: WhatIfOnayla veya UseTransaction.

Ayrıca Bkz.

  • Last updated on