Aliasy parametrów

  • Artykuł

Parametry polecenia cmdlet mogą również mieć aliasy. Podczas wpisywania lub określania parametru w poleceniu można użyć aliasów zamiast nazw parametrów.

Zalety używania aliasów

Dodanie aliasów do parametrów zapewnia następujące korzyści.

  • Możesz podać skrót, aby użytkownik nie musiał używać pełnej nazwy parametru podczas wywoływania polecenia cmdlet. Można na przykład użyć aliasu "CN" zamiast nazwy parametru "ComputerName".

  • Możesz zdefiniować wiele aliasów, jeśli chcesz podać różne nazwy dla tego samego parametru. Jeśli musisz pracować z wieloma grupami użytkowników odwołującymi się do tych samych danych na różne sposoby, możesz zdefiniować wiele aliasów.

  • W przypadku zmiany nazwy parametru można zapewnić zgodność z poprzednimi wersjami dla istniejących skryptów.

  • Używając atrybutu Alias wraz z atrybutem ValueFromPipelineByName, można zdefiniować parametr, który umożliwia powiązanie polecenia cmdlet z różnymi typami obiektów. Załóżmy na przykład, że masz dwa obiekty różnych typów, a pierwszy obiekt miał właściwość writer, a drugi obiekt miał właściwość edytora. Jeśli polecenie cmdlet miało parametr, który miał aliasy zapisu i edytora, a polecenie cmdlet akceptowało dane wejściowe potoku w nazwach właściwości, to polecenie cmdlet może powiązać oba obiekty przy użyciu dwóch aliasów parametrów.

Aby uzyskać więcej informacji na temat aliasów, które mogą być używane z określonymi parametrami, zobacz Typowe nazwy parametrów.

Definiowanie aliasów parametrów

Aby zdefiniować alias dla parametru, zadeklaruj atrybut Alias, jak pokazano w poniższej deklaracji parametru. W tym przykładzie dla tego samego parametru zdefiniowano wiele aliasów. Aby uzyskać więcej informacji, zobaczHow to Declare Cmdlet Parameters (Jak zadeklarować parametry polecenia cmdlet).

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

Zobacz też

Typowe nazwy parametrów

Jak zadeklarować parametry polecenia cmdlet

Pisanie polecenia cmdlet programu Windows PowerShell