Declaración de propiedades como parámetros

En este tema se proporciona información básica que debe comprender antes de declarar los parámetros de un cmdlet.

Para declarar los parámetros de un cmdlet dentro de la clase de cmdlet, defina las propiedades públicas que representan cada parámetro y agregue uno o varios atributos Parameter a cada propiedad. El Windows PowerShell runtime usa los atributos Parameter para identificar la propiedad como un parámetro de cmdlet. La sintaxis básica para declarar el atributo Parameter es [Parameter()] .

Este es un ejemplo de una propiedad definida como un parámetro obligatorio.

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

Estos son algunos aspectos que debe recordar sobre los parámetros.

• Un parámetro debe marcarse explícitamente como público. Los parámetros que no están marcados como públicos tienen como valor predeterminado internal y no se encontrarán en el entorno Windows PowerShell ejecución.

• Los parámetros deben definirse como tipos de .NET Framework Microsoft para proporcionar una mejor validación de parámetros. Por ejemplo, los parámetros que están restringidos a un valor de un conjunto de valores deben definirse como un tipo de enumeración. Los parámetros que toman un valor de identificador uniforme de recursos (URI) deben ser de tipo System.Uri.

• Evite los parámetros de cadena básicos para todas las propiedades de texto de forma libre, pero sin formato.

• Puede agregar un parámetro a cualquier número de conjuntos de parámetros. Para obtener más información sobre los conjuntos de parámetros, vea Cmdlet Parameter Sets.

Windows PowerShell también proporciona un conjunto de parámetros comunes que están disponibles automáticamente para cada cmdlet. Para obtener más información sobre estos parámetros y sus alias, vea Cmdlet Common Parameters.

Consulte también

Parámetros comunes del cmdlet

Tipos de parámetro de cmdlet

Escribir un cmdlet de Windows PowerShell