Declaración de atributos de parámetros

El atributo Parameter identifica una propiedad pública de la clase de cmdlet como un parámetro de cmdlet.

Sintaxis

[Parameter()]
[Parameter(Named Parameters...)]

Parámetros

Obligatorio (System.Boolean) Parámetro con nombre opcional. True indica que el parámetro cmdlet es obligatorio. Si no se proporciona un parámetro requerido cuando se invoca el cmdlet, Windows PowerShell solicita al usuario un valor de parámetro. El valor predeterminado es falso.

ParameterSetName (System.String) Parámetro con nombre opcional. Especifica el conjunto de parámetros al que pertenece este parámetro de cmdlet. Si no se especifica ningún conjunto de parámetros, el parámetro pertenece a todos los conjuntos de parámetros.

Posición (System.Int32) Parámetro con nombre opcional. Especifica la posición del parámetro dentro de un comando de Windows PowerShell.

ValueFromPipeline (System.Boolean) Parámetro con nombre opcional. True indica que el parámetro cmdlet toma su valor de un objeto de canalización. Especifique esta palabra clave si el cmdlet accede al objeto completo, no solo a una propiedad del objeto. El valor predeterminado es falso.

ValueFromPipelineByPropertyName (System.Boolean) Parámetro con nombre opcional. True indica que el parámetro cmdlet toma su valor de una propiedad de un objeto de canalización que tiene el mismo nombre o el mismo alias que este parámetro. Por ejemplo, si el cmdlet tiene un parámetro Name y el objeto de canalización también tiene una propiedad Name, el valor de la propiedad Name se asigna a el parámetro Name del cmdlet. El valor predeterminado es falso.

ValueFromRemainingArguments (System.Boolean) Parámetro con nombre opcional. True indica que el parámetro del cmdlet acepta todos los argumentos restantes que se pasan al cmdlet. El valor predeterminado es falso.

HelpMessage Parámetro con nombre opcional. Especifica una breve descripción del parámetro. Windows PowerShell muestra este mensaje cuando se ejecuta un cmdlet y no se especifica un parámetro obligatorio.

HelpMessageBaseName Parámetro con nombre opcional. Especifica la ubicación donde residen los identificadores de recursos. Por ejemplo, este parámetro podría especificar un ensamblado de recursos que contenga mensajes de ayuda que desee localizar.

HelpMessageResourceId Parámetro con nombre opcional. Especifica el identificador de recurso para un mensaje de ayuda.

Observaciones

• Para obtener más información sobre cómo declarar este atributo, consulte Cómo declarar parámetros de cmdlet.

• Un cmdlet puede tener cualquier número de parámetros. Sin embargo, para una mejor experiencia de usuario, limite la cantidad de parámetros.

• Los parámetros deben declararse en campos o propiedades públicos no estáticos. Los parámetros deben declararse en las propiedades. La propiedad debe tener un descriptor de acceso público set y, si se especifica la palabra clave ValueFromPipeline o ValueFromPipelineByPropertyName, la propiedad debe tener un descriptor de acceso público get.

• Cuando especifique parámetros posicionales, limite el número de parámetros posicionales en un conjunto de parámetros a menos de cinco. Además, los parámetros posicionales no tienen por qué ser contiguos. Las posiciones 5, 100 y 250 funcionan igual que las posiciones 0, 1 y 2.

• Cuando no se especifica la palabra clave Position, se debe hacer referencia al parámetro cmdlet por su nombre.

• Cuando utilice conjuntos de parámetros, tenga en cuenta lo siguiente:

  • Cada conjunto de parámetros debe tener al menos un parámetro único. Un buen diseño de cmdlet indica que este parámetro único también debería ser obligatorio si es posible. Si su cmdlet está diseñado para ejecutarse sin parámetros, el parámetro único no puede ser obligatorio.

  • Ningún conjunto de parámetros debe contener más de un parámetro posicional con la misma posición.

  • Solo un parámetro en un conjunto de parámetros debe declarar ValueFromPipeline=true.

  • Varios parámetros pueden definir ValueFromPipelineByPropertyName=true.

• Para obtener más información sobre las pautas para los nombres de parámetros, consulte Nombres de parámetros de cmdlet.

• El atributo del parámetro está definido por la clase System.Management.Automation.Parameterattribute.

Ver también

Atributo.del.parámetro.de.la.automatización.de.la.gestión.del.sistema

Nombres de parámetros de cmdlet

Escribir un cmdlet de Windows PowerShell