Cómo declarar los parámetros del cmdlet

En estos ejemplos se muestra cómo declarar parámetros con nombre, posicionales, obligatorios, opcionales y [switch] . Estos ejemplos también muestran cómo definir un alias de parámetro.

Cómo declarar un parámetro con nombre

• Defina una propiedad pública como se muestra en el código siguiente. Al agregar el atributo Parameter, omita la Position palabra clave del atributo .

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

Para obtener más información sobre el atributo Parameter, vea Declaración de atributos de parámetro.

Cómo declarar un parámetro posicional

• Defina una propiedad pública como se muestra en el código siguiente. Al agregar el atributo Parameter, establezca la Position palabra clave en la posición del argumento. Un valor de 0 indica la primera posición.

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

Para obtener más información sobre el atributo Parameter, vea Declaración de atributos de parámetro.

Cómo declarar un parámetro obligatorio

• Defina una propiedad pública como se muestra en el código siguiente. Al agregar el atributo Parameter, establezca la Mandatory palabra clave trueen .

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

Para obtener más información sobre el atributo Parameter, vea Declaración de atributos de parámetro.

Cómo declarar un parámetro opcional

• Defina una propiedad pública como se muestra en el código siguiente. Al agregar el atributo Parameter, omita la Mandatory palabra clave .

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

Procedimiento para declarar un [switch] parámetro

• Defina una propiedad pública como tipo System.Management.Automation.SwitchParameter y, a continuación, declare el atributo Parameter.

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

Para obtener más información sobre el atributo Parameter, vea Declaración de atributos de parámetro.

Cómo declarar un parámetro con alias

• Defina una propiedad pública como se muestra en el código siguiente. Agregue un atributo Alias que muestre los alias para el parámetro . En este ejemplo, se definen tres alias para el mismo parámetro. El primer alias proporciona un acceso directo. Los alias segundo y tercero proporcionan nombres que puede usar para diferentes escenarios.

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

Para obtener más información sobre el atributo Alias, vea Declaración de atributos de alias.

Véase también

System.Management.Automation.SwitchParameter

Declaración de atributo de parámetro

Declaración de atributo alias

Escribir un cmdlet de PowerShell de Windows