Cómo declarar parámetros de cmdlet

Estos ejemplos muestran cómo declarar parámetros con nombre, posicionales, obligatorios, opcionales y de cambio. 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 siguiente código. Cuando agregue el atributo Parámetro, omita la palabra clave Position del atributo.

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

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

Cómo declarar un parámetro posicional

• Defina una propiedad pública como se muestra en el siguiente código. Cuando agrega el atributo Parámetro, establezca la palabra clave Position 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 de parámetro, consulte Declaración de atributo de parámetro.

Cómo declarar un parámetro obligatorio

• Defina una propiedad pública como se muestra en el siguiente código. Cuando agregue el atributo Parámetro, establezca la palabra clave Mandatory en true.

  [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 de parámetro, consulte Declaración de atributo de parámetro.

Cómo declarar un parámetro opcional

• Defina una propiedad pública como se muestra en el siguiente código. Cuando agregue el atributo Parámetro, omita la palabra clave Obligatorio.

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

Cómo declarar un parámetro de interruptor

• Defina una propiedad pública como tipo System.Management.Automation.SwitchParameter y luego 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 de parámetro, consulte Declaración de atributo de parámetro.

Cómo declarar un parámetro con alias

• Defina una propiedad pública como se muestra en el siguiente código. Agregue un atributo Alias que enumere los alias del parámetro. En este ejemplo, se definen tres alias para el mismo parámetro. El primer alias proporciona un atajo. El segundo y tercer alias proporcionan nombres que puede utilizar en 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, consulte Declaración de atributo Alias.

Ver también

Parámetro.de.cambio.de.automatización.de.gestión.del.sistema

Declaración de atributos de parámetros

Declaración de atributo de alias

Escribir un cmdlet de Windows PowerShell