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

Estes exemplos mostram como declarar os parâmetros nomeados, posicionais, necessários, opcionais e comutadores. Estes exemplos também mostram como definir um pseudónimo de parâmetro.

Como declarar um parâmetro nomeado

• Defina uma propriedade pública como mostrado no seguinte código. Quando adicionar o atributo 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 Parâmetro, consulte a Declaração de Atributos de Parâmetro.

Como declarar um parâmetro posicional

• Defina uma propriedade pública como mostrado no seguinte código. Quando adicionar o atributo Parâmetro, desista 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 Parâmetro, consulte a Declaração de Atributos de Parâmetro.

Como declarar um parâmetro obrigatório

• Defina uma propriedade pública como mostrado no seguinte código. Quando adicionar o atributo Parâmetro, desa um ponto Mandatory de sê-lo para 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 Parâmetro, consulte a Declaração de Atributos de Parâmetro.

Como declarar um parâmetro opcional

• Defina uma propriedade pública como mostrado no seguinte código. Quando adicionar o atributo 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 comutação

• Defina uma propriedade pública como tipo System.Management.Automation.SwitchParameter, e, em seguida, declare o atributo Parâmetro.

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

Para obter mais informações sobre o atributo Parâmetro, consulte a Declaração de Atributos de Parâmetro.

Como declarar um parâmetro com pseudónimos

• Defina uma propriedade pública como mostrado no seguinte código. Adicione um atributo Alias que lista os pseudónimos para o 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 pode usar para diferentes cenários.

  [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 a Declaração de Atributo alias.

Consulte também

System.Management.Automation.SwitchParameter

Parameter Attribute Declaration (Declaração do Atributo Parameter)

Alias Attribute Declaration (Declaração do Atributo Alias)

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