Alias de parámetro

Los parámetros de cmdlet también pueden tener alias. Puede usar los alias en lugar de los nombres de parámetro al escribir o especificar el parámetro en un comando.

Ventajas de usar alias

Agregar alias a parámetros proporciona las siguientes ventajas.

• Puede proporcionar un acceso directo para que el usuario no tenga que usar el nombre completo del parámetro cuando se llama al cmdlet. Por ejemplo, podría usar el alias "CN" en lugar del nombre del parámetro "NombreDeEquipo".

• Puede definir varios alias si desea proporcionar nombres diferentes para el mismo parámetro. Es posible que quiera definir varios alias si tiene que trabajar con varios grupos de usuarios que hacen referencia a los mismos datos de maneras diferentes.

• Puede proporcionar compatibilidad con versiones anteriores para los scripts existentes si cambia el nombre de un parámetro.

• Mediante el uso del atributo Alias junto con el atributo ValueFromPipelineByName, puede definir un parámetro que permita que el cmdlet se enlace a distintos tipos de objeto. Por ejemplo, digamos que tenía dos objetos de tipos diferentes y que el primer objeto tenía una propiedad writer y el segundo objeto tenía una propiedad de editor. Si el cmdlet tenía un parámetro que tenía alias de escritor y editor y el cmdlet aceptaba la entrada de canalización basada en nombres de propiedad, el cmdlet podría enlazarse a ambos objetos mediante los dos alias de parámetro.

Para obtener más información sobre los alias que se pueden usar con parámetros específicos, vea Common Parameter Names.

Definir alias de parámetro

Para definir un alias para un parámetro, declare el atributo Alias, como se muestra en la siguiente declaración de parámetro. En este ejemplo, se definen varios alias para el mismo parámetro. (Para obtener más información,vea Cómo declarar parámetros de cmdlet).

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

Consulte también

Nombres de parámetros comunes

Cómo declarar los parámetros del cmdlet

Escribir un cmdlet de Windows PowerShell