Parametre Özellik Bildirimi
Parameter özniteliği, cmdlet sınıfının ortak özelliğini bir cmdlet parametresi olarak tanımlar.
Sözdizimi
[Parameter()]
[Parameter(Named Parameters...)]
Parametreler
Zorunlu (System.Boolean) İsteğe bağlı adlandırılmış parametre. True cmdlet parametresinin gerekli olduğunu belirtir. Cmdlet çağrıldığında gerekli bir parametre sağlanmazsa Windows PowerShell kullanıcıdan bir parametre değeri ister. Varsayılan yanlış'tır.
ParameterSetName (System.String) İsteğe bağlı adlandırılmış parametre. Bu cmdlet parametresinin ait olduğu parametre kümesini belirtir. Herhangi bir parametre seti belirtilmemişse parametre tüm parametre setlerine aittir.
Pozisyon (System.Int32) İsteğe bağlı adlandırılmış parametre. Parametrenin Windows PowerShell komutu içindeki konumunu belirtir.
ValueFromPipeline (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, cmdlet parametresinin değerini bir ardışık düzen nesnesinden aldığını belirtir. Cmdlet yalnızca nesnenin bir özelliğine değil, nesnenin tamamına erişiyorsa bu anahtar sözcüğü belirtin. Varsayılan yanlış'tır.
ValueFromPipelineByPropertyName (System.Boolean) İsteğe bağlı adlandırılmış parametre. Doğru, cmdlet parametresinin değerini, bu parametreyle aynı adı veya diğer adı taşıyan bir ardışık düzen nesnesinin özelliğinden aldığını belirtir. Örneğin, cmdlet'in bir Ad parametresi varsa ve ardışık düzen nesnesinin de bir Ad özelliği varsa, Ad özelliğinin değeri şuna atanır: cmdlet'in Ad parametresi. Varsayılan yanlış'tır.
ValueFromRemainingArguments (System.Boolean) İsteğe bağlı adlandırılmış parametre. True, cmdlet parametresinin cmdlet'e iletilen kalan tüm bağımsız değişkenleri kabul ettiğini belirtir. Varsayılan yanlış'tır.
HelpMessage İsteğe bağlı adlandırılmış parametre. Parametrenin kısa bir açıklamasını belirtir. Windows PowerShell, bir cmdlet çalıştırıldığında ve zorunlu bir parametre belirtilmediğinde bu mesajı görüntüler.
HelpMessageBaseName İ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 derlemesini belirtebilir.
HelpMessageResourceId İsteğe bağlı adlandırılmış parametre.Yardım iletisinin kaynak tanımlayıcısını belirtir.
Notlar
Bu özniteliğin nasıl bildirileceği hakkında daha fazla bilgi için bkz. Cmdlet Parametreleri Nasıl Bildirilir.
Bir 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 genel statik olmayan alanlarda veya özelliklerde bildirilmelidir. Parametreler özelliklerde bildirilmelidir. Özelliğin ortak ayarlanmış bir erişimcisi olmalıdır ve
ValueFromPipelineveyaValueFromPipelineByPropertyNameanahtar sözcüğü belirtilirse, özelliğin genel bir erişim erişimcisi olması gerekir.Konumsal parametreleri belirttiğinizde, bir parametre setindeki konumsal parametrelerin sayısını beşten az olacak şekilde sınırlayın. Ve konumsal parametrelerin bitişik olması gerekmez. 5, 100 ve 250 konumları 0, 1 ve 2 konumlarıyla aynı şekilde çalışır.
Positionanahtar sözcüğü belirtilmediğinde cmdlet parametresine adıyla başvurulmalıdır.-
Parametre kümelerini kullanırken aşağıdakilere dikkat edin:
Her parametre setinde en az bir benzersiz parametre bulunmalıdır. İyi cmdlet tasarımı, bu benzersiz parametrenin mümkünse zorunlu olması gerektiğini de gösterir. Cmdlet'iniz parametre olmadan çalışacak şekilde tasarlandıysa benzersiz parametre zorunlu olamaz.
Hiçbir parametre seti aynı konuma sahip birden fazla konumsal parametre içermemelidir.
Bir parametre kümesindeki yalnızca bir parametre
ValueFromPipeline=truedeğerini bildirmelidir.ValueFromPipelineByPropertyName=true'yi birden çok parametre tanımlayabilir.
Parametre adlarına ilişkin yönergeler 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.
Ayrıca Bakınız
System.Management.Automation.Parameter özelliği
Cmdlet Parametre Adları
Windows PowerShell Cmdlet'i Yazma