Псевдонимы параметров

Параметры командлета также могут иметь псевдонимы. Вместо имен параметров можно использовать псевдонимы при вводе или указании параметра в команде.

Преимущества использования псевдонимов

Добавление псевдонимов в параметры предоставляет следующие преимущества.

  • Можно указать ярлык, чтобы пользователю не применялись полные имена параметров при вызове командлета. Например, можно использовать псевдоним CN вместо имени параметра ComputerName.

  • Можно определить несколько псевдонимов, если нужно указать разные имена для одного и того же параметра. Может потребоваться определить несколько псевдонимов, если необходимо работать с несколькими группами пользователей, которые ссылаются на одни и те же данные различными способами.

  • При изменении имени параметра можно обеспечить обратную совместимость существующих скриптов.

  • С помощью атрибута Alias вместе с атрибутом Валуефромпипелинебинаме можно определить параметр, позволяющий командлету выполнить привязку к различным типам объектов. Например, предположим, что у вас есть два объекта различных типов и первый объект имел свойство Writer, а второй объект имел свойство редактора. Если у командлета есть параметр, имеющий псевдонимы модуля записи и редактора, а командлет принял входные данные конвейера на основе имен свойств, командлет может выполнить привязку к обоим объектам с помощью двух псевдонимов параметров.

Дополнительные сведения о псевдонимах, которые можно использовать с конкретными параметрами, см. в разделе Общие имена параметров.

Определение псевдонимов параметров

Чтобы определить псевдоним для параметра, объявите атрибут Alias, как показано в следующем объявлении параметра. В этом примере для одного и того же параметра определено несколько псевдонимов. (Дополнительные сведения см.в разделе как объявлять параметры командлета.)

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

См. также:

Общие имена параметров

Как объявить параметры командлета

Запись командлета Windows PowerShell