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

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

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

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

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

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

Объявление позиционного параметра

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

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

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

Объявление обязательного параметра

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

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

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

Объявление необязательного параметра

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

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

Объявление [switch] параметра

• Определите общедоступное свойство как тип System.Management.Automation.SwitchParameter, а затем объявите атрибут Parameter.

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

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

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

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

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

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

См. также

System.Management.Automation.SwitchParameter

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

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

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