Aliases de parâmetro

  • Artigo

Os parâmetros de cmdlet também podem ter aliases. Você pode usar os aliases em vez dos nomes de parâmetro ao digitar ou especificar o parâmetro em um comando.

Benefícios do uso de aliases

Adicionar aliases a parâmetros oferece os seguintes benefícios.

  • Você pode fornecer um atalho para que o usuário não tenha que usar o nome do parâmetro completo quando o cmdlet for chamado. Por exemplo, você pode usar o alias "CN" em vez do nome do parâmetro "ComputerName".

  • Você poderá definir vários aliases se quiser fornecer nomes diferentes para o mesmo parâmetro. Talvez você queira definir vários aliases se precisar trabalhar com vários grupos de usuários que se referem aos mesmos dados de maneiras diferentes.

  • Você poderá fornecer compatibilidade com compatibilidade com vertida para scripts existentes se o nome de um parâmetro for alteração.

  • Usando o atributo Alias junto com o atributo ValueFromPipelineByName, você pode definir um parâmetro que permite que o cmdlet se a bind a diferentes tipos de objeto. Por exemplo, digamos que você tinha dois objetos de tipos diferentes e o primeiro objeto tinha uma propriedade writer e o segundo objeto tinha uma propriedade de editor. Se o cmdlet tivesse um parâmetro que tinha aliases de editor e de autor e o cmdlet aceitava a entrada de pipeline com base em nomes de propriedade, o cmdlet poderia se vincular a ambos os objetos usando os dois aliases de parâmetro.

Para obter mais informações sobre aliases que podem ser usados com parâmetros específicos, consulte Nomes de parâmetro comuns.

Definindo aliases de parâmetro

Para definir um alias para um parâmetro, declare o atributo Alias, conforme mostrado na declaração de parâmetro a seguir. Neste exemplo, vários aliases são definidos para o mesmo parâmetro. (Para obter mais informações,consulte How to Declare Cmdlet Parameters.)

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

Consulte Também

Nomes de parâmetro comuns

Como declarar parâmetros de cmdlet

Writing a Windows PowerShell Cmdlet (Escrevendo um Cmdlet do Windows PowerShell)