Lezen in het Engels

Delen via


Parameteraliassen

Cmdlet-parameters kunnen ook aliassen hebben. U kunt de aliassen gebruiken in plaats van de parameternamen wanneer u typt of de parameter in een opdracht opgeeft.

Voordelen van het gebruik van aliassen

Het toevoegen van aliassen aan parameters biedt de volgende voordelen.

  • U kunt een snelkoppeling opgeven zodat de gebruiker niet de volledige parameternaam hoeft te gebruiken wanneer de cmdlet wordt aangeroepen. U kunt bijvoorbeeld de ALIAS 'CN' gebruiken in plaats van de parameternaam 'ComputerName'.

  • U kunt meerdere aliassen definiëren als u verschillende namen voor dezelfde parameter wilt opgeven. Mogelijk wilt u meerdere aliassen definiëren als u met meerdere gebruikersgroepen moet werken die op verschillende manieren naar dezelfde gegevens verwijzen.

  • U kunt achterwaartse compatibiliteit voor bestaande scripts opgeven als de naam van een parameter verandert.

  • Door het kenmerk Alias samen met het kenmerk ValueFromPipelineByName te gebruiken, kunt u een parameter definiëren waarmee uw cmdlet een binding kan maken met verschillende objecttypen. Stel dat u twee objecten van verschillende typen had en het eerste object een schrijf-eigenschap had en het tweede object een editor-eigenschap. Als uw cmdlet een parameter had met writer- en editor-aliassen en de cmdlet pijplijninvoer accepteerde op basis van eigenschapsnamen, kan uw cmdlet met behulp van de twee parameteraliassen een binding maken met beide objecten.

Zie Algemene parameternamen voor meer informatie over aliassen die kunnen worden gebruikt met specifiekeparameters.

Parameteraliassen definiëren

Als u een alias voor een parameter wilt definiëren, declareer dan het kenmerk Alias, zoals wordt weergegeven in de volgende parameterdeclaratie. In dit voorbeeld worden meerdere aliassen gedefinieerd voor dezelfde parameter. (Zie Howto Declare Cmdlet Parameters (Cmdlet-parameters declareeren)) voor meerinformatie.

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

Zie ook

Namen van veelvoorkomende parameters

Cmdlet-parameters declareren

Een Windows PowerShell-cmdlet schrijven