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

В этих примерах показано, как объявить именованные, позиционированные, обязательные, необязательные и параметры Switch. В этих примерах также показано, как определить псевдоним параметра.

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

• Определите открытое свойство, как показано в следующем коде. При добавлении атрибута параметра опустите Position ключевое слово из атрибута.

  [Parameter()]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Дополнительные сведения об атрибуте Parameter см. в разделе объявление атрибута Parameter.

Как объявить Позиционированный параметр

• Определите открытое свойство, как показано в следующем коде. При добавлении атрибута Parameter задайте Position для ключевого слова значение, равное положению аргумента. Значение 0 указывает на первую точку.

  [Parameter(Position = 0)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Дополнительные сведения об атрибуте Parameter см. в разделе объявление атрибута Parameter.

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

• Определите открытое свойство, как показано в следующем коде. При добавлении атрибута параметра задайте Mandatory для ключевого слова значение true .

  [Parameter(Position = 0, Mandatory = true)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Дополнительные сведения об атрибуте Parameter см. в разделе объявление атрибута Parameter.

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

• Определите открытое свойство, как показано в следующем коде. При добавлении атрибута параметра опустите Mandatory ключевое слово.

  [Parameter(Position = 0)]
  public string UserName
  {
    get { return userName; }
    set { userName = value; }
  }
  private string userName;
  

Как объявить параметр Switch

• Определите открытое свойство как Type System. Management. Automation. переключатель, а затем объявите атрибут Parameter.

  [Parameter(Position = 1)]
  public SwitchParameter GoodBye
  {
    get { return goodbye; }
    set { goodbye = value; }
  }
  private bool goodbye;
  

Дополнительные сведения об атрибуте Parameter см. в разделе объявление атрибута Parameter.

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

• Определите открытое свойство, как показано в следующем коде. Добавьте атрибут Alias, содержащий псевдонимы для параметра. В этом примере для одного и того же параметра определены три псевдонима. Первый псевдоним предоставляет ярлык. Второй и третий псевдонимы предоставляют имена, которые можно использовать для различных сценариев.

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

Дополнительные сведения об атрибуте Alias см. в разделе объявление атрибута Alias.

См. также:

System.Management.Automation.SwitchParameter

Объявление атрибута параметра

Объявление атрибута псевдонима

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