Como declarar parâmetros de cmdlet

Esses exemplos mostram como declarar parâmetros nomeados, posicionais, necessários, opcionais e [switch] opcionais. 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. Ao adicionar o atributo Parameter, 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 Parameter, consulte a 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 Parameter, defina a Position palavra-chave para 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 Parameter, consulte a 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 Parameter, 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 Parameter, consulte a 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. Ao adicionar o atributo Parameter, omita a Mandatory palavra-chave.

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

Como declarar um [switch] parâmetro

• Defina uma propriedade pública como o tipo System.Management.Automation.SwitchParameter e 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 Parameter, consulte a 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 Alias que lista 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 Alias Attribute Declaration.

Consulte Também

System.Management.Automation.SwitchParameter

Declaração de atributo de parâmetro

Declaração de Atributo de Alias

Escritando um cmdlet do PowerShell Windows