Deklarieren von Eigenschaften als Parameter

Dieses Thema enthält grundlegende Informationen, die Sie verstehen müssen, bevor Sie die Parameter eines Cmdlets deklarieren.

Um die Parameter eines Cmdlets in ihrer Cmdlet-Klasse zu deklarieren, definieren Sie die öffentlichen Eigenschaften, die jeden Parameter darstellen, und fügen Sie dann jeder Eigenschaft ein oder mehrere Parameterattribute hinzu. Die Windows PowerShell Runtime verwendet die Parameterattribute, um die Eigenschaft als Cmdlet-Parameter zu identifizieren. Die grundlegende Syntax zum Deklarieren des Parameter-Attributs ist [Parameter()] .

Hier ist ein Beispiel für eine Eigenschaft, die als erforderlicher Parameter definiert ist.

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

Im Folgenden finden Sie einige Punkte, die Sie sich über Parameter merken sollten.

• Ein Parameter muss explizit als öffentlich gekennzeichnet werden. Parameter, die nicht als öffentlicher Standardwert für intern markiert sind und von der Windows PowerShell Runtime nicht gefunden werden.

• Parameter sollten als Microsoft .NET Framework-Typen definiert werden, um eine bessere Parametervalidierung zu ermöglichen. Parameter, die auf einen Wert aus einer Gruppe von Werten beschränkt sind, sollten beispielsweise als Enumerationstyp definiert werden. Parameter, die einen Uniform Resource Identifier -Wert (URI) annehmen, sollten vom Typ System.Urisein.

• Vermeiden Sie grundlegende Zeichenfolgenparameter für alle Texteigenschaften außer Freiform.

• Sie können einen Parameter zu einer beliebigen Anzahl von Parametersätzen hinzufügen. Weitere Informationen zu Parametersätzen finden Sie unter Cmdlet-Parametersätze.

Windows PowerShell stellt auch eine Reihe allgemeiner Parameter bereit, die automatisch für jedes Cmdlet verfügbar sind. Weitere Informationen zu diesen Parametern und ihren Aliasen finden Sie unter Cmdlet Common Parameters.

Weitere Informationen

Allgemeine Cmdlet-Parameter

Typen von Cmdlet-Parametern

Schreiben eines Windows PowerShell-Cmdlets