Parameter Aliases (Aliases de Parâmetros)

Os parâmetros do cmdlet também podem ter pseudónimos. Pode utilizar os pseudónimos em vez dos nomes dos parâmetros quando digita ou especifica o parâmetro num comando.

Benefícios da utilização de pseudónimos

A adição de pseudónimos aos parâmetros proporciona os seguintes benefícios.

• Pode fornecer um atalho para que o utilizador não tenha de usar o nome do parâmetro completo quando o cmdlet for chamado. Por exemplo, pode utilizar o pseudónimo "CN" em vez do nome de parâmetro "ComputerName".

• Pode definir vários pseudónimos se quiser fornecer nomes diferentes para o mesmo parâmetro. É melhor definir vários pseudónimos se tiver de trabalhar com vários grupos de utilizadores que se referem aos mesmos dados de diferentes formas.

• Pode fornecer retrocompatibilidade para scripts existentes se o nome de um parâmetro mudar.

• Ao utilizar o atributo Alias juntamente com o atributo ValueFromPipelineByName, pode definir um parâmetro que permite que o seu cmdlet se ligue a diferentes tipos de objetos. Por exemplo, digamos que você tinha dois objetos de diferentes tipos e o primeiro objeto tinha uma propriedade de escritor e o segundo objeto tinha uma propriedade editor. Se o seu cmdlet tivesse um parâmetro que tivesse pseudónimos de escritor e editor e a entrada aceite do oleoduto cmdlet baseada em nomes de propriedade, o seu cmdlet poderia ligar-se a ambos os objetos usando os dois pseudónimos parâmetros.

Para obter mais informações sobre pseudónimos que podem ser utilizados com parâmetros específicos, consulte nomes de parâmetros comuns.

Definição de pseudónimos de parâmetros

Para definir um pseudónimo para um parâmetro, declare o atributo Alias, como mostra a seguinte declaração de parâmetro. Neste exemplo, vários pseudónimos são definidos para o mesmo parâmetro. (Para mais informações, consulteComo Declarar Parâmetros Cmdlet.)

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

Consulte também

Common Parameter Names (Nomes de Parâmetros Comuns)

How to Declare Cmdlet Parameters (Como Declarar Parâmetros de Cmdlets)

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