Como declarar parâmetros de cmdlet

Esses exemplos mostram como declarar parâmetros nomeados, posicionais, obrigatórios, opcionais e de comutação. Esses exemplos também mostram como definir um alias de parâmetro.

Como declarar um parâmetro nomeado

• Defina uma propriedade pública, conforme mostrado no código a seguir. Quando você adicionar o atributo de parâmetro, omita a Position palavra-chave do atributo.

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

Para obter mais informações sobre o atributo de parâmetro, consulte declaração de atributo de parâmetro.

Como declarar um parâmetro posicional

• Defina uma propriedade pública, conforme mostrado no código a seguir. Ao adicionar o atributo de parâmetro, defina a Position palavra-chave como a posição do argumento. Um valor de 0 indica a primeira posição.

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

Para obter mais informações sobre o atributo de parâmetro, consulte declaração de atributo de parâmetro.

Como declarar um parâmetro obrigatório

• Defina uma propriedade pública, conforme mostrado no código a seguir. Ao adicionar o atributo de parâmetro, defina a Mandatory palavra-chave como true .

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

Para obter mais informações sobre o atributo de parâmetro, consulte declaração de atributo de parâmetro.

Como declarar um parâmetro opcional

• Defina uma propriedade pública, conforme mostrado no código a seguir. Quando você adicionar o atributo de parâmetro, omita a Mandatory palavra-chave.

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

Como declarar um parâmetro de opção

• Defina uma propriedade pública como tipo System. Management. Automation. SwitchParametere, em seguida, declare o atributo Parameter.

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

Para obter mais informações sobre o atributo de parâmetro, consulte declaração de atributo de parâmetro.

Como declarar um parâmetro com aliases

• Defina uma propriedade pública, conforme mostrado no código a seguir. Adicione um atributo de alias que liste os aliases para o parâmetro. Neste exemplo, três aliases são definidos para o mesmo parâmetro. O primeiro alias fornece um atalho. O segundo e o terceiro aliases fornecem nomes que você pode usar para cenários diferentes.

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

Para obter mais informações sobre o atributo Alias, consulte declaração de atributo de alias.

Consulte Também

System.Management.Automation.SwitchParameter

Declaração de atributo de parâmetro

Declaração de atributo de alias

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