How to Declare Dynamic Parameters (Como Declarar Parâmetros Dinâmicos)

  • Artigo

Este exemplo mostra como definir parâmetros dinâmicos que são adicionados ao cmdlet em tempo de execução. Neste exemplo, o Department parâmetro é adicionado ao cmdlet sempre que o utilizador especificar o parâmetro do Employee interruptor. Para obter mais informações sobre parâmetros dinâmicos, consulte os Parâmetros Dinâmicos Cmdlet.

Para definir parâmetros dinâmicos

  1. Na declaração de classe cmdlet, adicione a interface System.Management.Automation.Idynamicparameters, como mostrado.

    public class SendGreetingCommand : Cmdlet, IDynamicParameters

  2. Ligue para o método System.Management.Automation.Idynamicparameters.Getdynamicparameters* que devolve o objeto em que os parâmetros dinâmicos são definidos. Neste exemplo, o método é chamado quando o Employee parâmetro é especificado.

    public object GetDynamicParameters()
{
    if (employee)
    {
      context= new SendGreetingCommandDynamicParameters();
      return context;
    }
    return null;
}
private SendGreetingCommandDynamicParameters context;

  3. Declare uma classe que defina os parâmetros dinâmicos a adicionar. Pode utilizar os atributos utilizados para declarar os parâmetros estáticos do cmdlet para declarar os parâmetros dinâmicos.

    public class SendGreetingCommandDynamicParameters
{
  [Parameter]
  [ValidateSet ("Marketing", "Sales", "Development")]
  public string Department
  {
    get { return department; }
    set { department = value; }
  }
  private string department;
}

Exemplo

Neste exemplo, o Department parâmetro é adicionado sempre que o utilizador especifica o Employee parâmetro. O Department parâmetro é um parâmetro opcional, e o atributo ValidateSet é usado para especificar os argumentos permitidos.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Management.Automation;     // PowerShell assembly.

namespace SendGreeting
{
  // Declare the cmdlet class that supports the
  // IDynamicParameters interface.
  [Cmdlet(VerbsCommunications.Send, "Greeting")]
  public class SendGreetingCommand : Cmdlet, IDynamicParameters
  {
    // Declare the parameters for the cmdlet.
    [Parameter(Mandatory = true)]
    public string Name
    {
      get { return name; }
      set { name = value; }
    }
    private string name;

    [Parameter]
    [Alias ("FTE")]
    public SwitchParameter Employee
    {
      get { return employee; }
      set { employee = value; }
    }
    private Boolean employee;

    // Implement GetDynamicParameters to
    // retrieve the dynamic parameter.
    public object GetDynamicParameters()
    {
      if (employee)
      {
        context= new SendGreetingCommandDynamicParameters();
        return context;
      }
      return null;
   }
   private SendGreetingCommandDynamicParameters context;

    // Overide the ProcessRecord method to process the
    // supplied user name and write out a greeting to
    // the user by calling the WriteObject method.
    protected override void ProcessRecord()
    {
      WriteObject("Hello " + name + "! ");
      if (employee)
      {
        WriteObject("Department: " + context.Department);
      }
    }
  }

  // Define the dynamic parameters to be added
  public class SendGreetingCommandDynamicParameters
  {
    [Parameter]
    [ValidateSet ("Marketing", "Sales", "Development")]
    public string Department
    {
      get { return department; }
      set { department = value; }
    }
    private string department;
  }
}

Consulte também

Sistema.Management.Automation.Runtimedefinedparametdictionary

System.Management.Automation.Idynamicparameters.Getdynamicparameters*

Cmdlet Dynamic Parameters (Parâmetros Dinâmicos de Cmdlets)

Windows PowerShell SDK (SDK do Windows PowerShell)