Parameteralias

Cmdlet-parametrar kan också ha alias. Du kan använda aliasen i stället för parameternamnen när du skriver eller anger parametern i ett kommando.

Fördelar med att använda alias

Att lägga till alias i parametrar ger följande fördelar.

• Du kan ange en genväg så att användaren inte behöver använda det fullständiga parameternamnet när cmdleten anropas. Du kan till exempel använda aliaset "CN" i stället för parameternamnet "ComputerName".

• Du kan definiera flera alias om du vill ange olika namn för samma parameter. Du kanske vill definiera flera alias om du måste arbeta med flera användargrupper som refererar till samma data på olika sätt.

• Du kan ge bakåtkompatibilitet för befintliga skript om namnet på en parameter ändras.

• Genom att använda aliasattributet tillsammans med attributet ValueFromPipelineByName kan du definiera en parameter som gör att din cmdlet kan binda till olika objekttyper. Säg till exempel att du hade två objekt av olika typer och att det första objektet hade en writer-egenskap och att det andra objektet hade en redigeringsegenskap. Om cmdleten hade en parameter som hade alias för skrivare och redigerare och cmdleten accepterade pipelineindata baserade i egenskapsnamn, kan cmdleten binda till båda objekten med hjälp av de två parameteraliasen.

Mer information om alias som kan användas med specifika parametrar finns i Vanliga parameternamn.

Definiera parameteralias

Om du vill definiera ett alias för en parameter deklarerar du attributet Alias, som du ser i följande parameterdeklaration. I det här exemplet definieras flera alias för samma parameter. (Mer information finns i Deklareracmdlet-parametrar.)

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

Se även

Vanliga parameternamn

Deklarera cmdlet-parametrar

Skriva en Windows PowerShell-cmdlet