How to Declare Cmdlet Parameters (Como Declarar Parâmetros de Cmdlets)

Estes exemplos mostram como declarar parâmetros, nomeados, posicionais, obrigatórios, opcionais e [switch] parâmetros. Estes 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 seguinte. Quando adicionas o atributo Parâmetro, omite a Position palavra-chave do atributo.

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

Para mais informações sobre o atributo Parâmetro, veja Declaração de Atributo Parâmetro.

Como Declarar um Parâmetro Posicional

• Defina uma propriedade pública conforme mostrado no código seguinte. Quando adicionares o atributo Parâmetro, define 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 mais informações sobre o atributo Parâmetro, veja Declaração de Atributo Parâmetro.

Como Declarar um Parâmetro Obrigatório

• Defina uma propriedade pública conforme mostrado no código seguinte. Quando adicionar o atributo Parâmetro, defina a Mandatory palavra-chave para true.

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

Para mais informações sobre o atributo Parâmetro, veja Declaração de Atributo Parâmetro.

Como Declarar um Parâmetro Opcional

• Defina uma propriedade pública conforme mostrado no código seguinte. Quando adicionares o atributo Parâmetro, omite 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 tipo System.Management.Automation.SwitchParameter, e depois declare o atributo Parâmetro.

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

Para mais informações sobre o atributo Parâmetro, veja Declaração de Atributo Parâmetro.

Como Declarar um Parâmetro com Aliases

• Defina uma propriedade pública conforme mostrado no código seguinte. Adicione um atributo Alias que liste os alias do parâmetro. Neste exemplo, três pseudónimos são definidos para o mesmo parâmetro. O primeiro pseudónimo fornece um atalho. O segundo e terceiro pseudónimos fornecem nomes que podes usar em diferentes cenários.

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

Para mais informações sobre o atributo Alias, consulte Declaração de Atributo Alias.

Ver também

System.Management.Automation.SwitchParameter

Declaração do Atributo do Parâmetro

Declaração de Atributo Alias

A escrever um Windows PowerShell Cmdlet