Deklarowanie właściwości jako parametrów

  • Artykuł

Ten temat zawiera podstawowe informacje, które należy zrozumieć przed zadeklarowaniem parametrów polecenia cmdlet.

Aby zadeklarować parametry polecenia cmdlet w klasie polecenia cmdlet, zdefiniuj właściwości publiczne, które reprezentują każdy parametr, a następnie dodaj co najmniej jeden atrybut Parameter do każdej właściwości. Środowisko Windows PowerShell używa atrybutów parametru do identyfikowania właściwości jako parametru polecenia cmdlet. Podstawowa składnia do deklarowania atrybutu parametru to [Parameter()] .

Oto przykład właściwości zdefiniowanej jako wymagany parametr.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Oto kilka rzeczy, które należy zapamiętać o parametrach.

  • Parametr musi być jawnie oznaczony jako publiczny. Parametry, które nie są oznaczone jako publiczne domyślne jako wewnętrzne i nie zostaną znalezione przez Windows PowerShell uruchomieniowe.

  • Parametry powinny być zdefiniowane jako typy .NET Framework Microsoft, aby zapewnić lepszą weryfikację parametrów. Na przykład parametry, które są ograniczone do jednej wartości z zestawu wartości, powinny być zdefiniowane jako typ wyliczenia. Parametry, które Uniform Resource Identifier (URI), powinny mieć typ System.Uri.

  • Unikaj podstawowych parametrów ciągu dla wszystkich właściwości tekstu o foremce wolnej.

  • Parametr można dodać do dowolnej liczby zestawów parametrów. Aby uzyskać więcej informacji na temat zestawów parametrów, zobacz Zestawy parametrów polecenia cmdlet.

Windows PowerShell udostępnia również zestaw typowych parametrów, które są automatycznie dostępne dla każdego polecenia cmdlet. Aby uzyskać więcej informacji na temat tych parametrów i ich aliasów, zobacz Typowe parametry polecenia cmdlet.

Zobacz też

Typowe parametry polecenia cmdlet

Typy parametrów polecenia cmdlet

Pisanie polecenia cmdlet programu Windows PowerShell