Parameteraliase

Cmdlet-Parameter können auch Aliase aufweisen. Sie können die Aliase anstelle der Parameternamen verwenden, wenn Sie den Parameter in einem Befehl eingeben oder angeben.

Vorteile der Verwendung von Aliasen

Das Hinzufügen von Aliasen zu Parametern bietet die folgenden Vorteile.

• Sie können eine Verknüpfung angeben, damit der Benutzer beim Aufrufen des Cmdlets nicht den vollständigen Parameternamen verwenden muss. Beispielsweise können Sie den Alias "CN" anstelle des Parameternamens "ComputerName" verwenden.

• Sie können mehrere Aliase definieren, wenn Sie unterschiedliche Namen für denselben Parameter angeben möchten. Sie können mehrere Aliase definieren, wenn Sie mit mehreren Benutzergruppen arbeiten müssen, die auf unterschiedliche Weise auf dieselben Daten verweisen.

• Sie können Abwärtskompatibilität für vorhandene Skripts bereitstellen, wenn sich der Name eines Parameters ändert.

• Indem Sie das Alias-Attribut zusammen mit dem ValueFromPipelineByName-Attribut verwenden, können Sie einen Parameter definieren, mit dem Ihr Cmdlet an verschiedene Objekttypen gebunden werden kann. Angenommen, Sie hatten zwei Objekte unterschiedlicher Typen, und das erste Objekt hatte eine Writer-Eigenschaft und das zweite Objekt eine Editor-Eigenschaft. Wenn Ihr Cmdlet über einen Parameter mit Writer- und Editoraliasen verfügt und das Cmdlet Pipelineeingaben basierend auf Eigenschaftsnamen akzeptiert hat, könnte Ihr Cmdlet mithilfe der beiden Parameteraliase an beide Objekte gebunden werden.

Weitere Informationen zu Aliasen, die mit bestimmten Parametern verwendet werden können, finden Sie unter Allgemeine Parameternamen.

Definieren von Parameteraliasen

Um einen Alias für einen Parameter zu definieren, deklarieren Sie das Alias-Attribut, wie in der folgenden Parameterdeklaration gezeigt. In diesem Beispiel werden mehrere Aliase für denselben Parameter definiert. (Weitere Informationen finden Sie unterDeklarieren von Cmdlet-Parametern.)

[Alias("UN","Writer","Editor")]
[Parameter()]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Weitere Informationen

Allgemeine Parameternamen

Deklarieren von Cmdlet-Parametern

Schreiben eines Windows PowerShell-Cmdlets