Declaración de atributo de parámetro

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

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

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.

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

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

ValueFromPipelineByPropertyName (System.Boolean) Parámetro con nombre opcional. True indica que el parámetro de 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 y el objeto de canalización también tiene una propiedad , el valor de la propiedad se asigna al Name Name parámetro del Name Name cmdlet. El valor predeterminado es false.

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 false.

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 los mensajes de Ayuda que desea encontrar.

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

Comentarios

• Para obtener más información sobre cómo declarar este atributo, vea How to Declare Cmdlet Parameters.

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

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

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

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

• Cuando use 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 debe ser obligatorio si es posible. Si el 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 de un conjunto de parámetros debe declarar ValueFromPipeline = true .

  • Varios parámetros pueden definir ValueFromPipelineByPropertyName = true .

• Para obtener más información sobre las directrices para los nombres de parámetro, vea Cmdlet Parameter Names.

• La clase System.Management.Automation.Parameterattribute define el atributo de parámetro.

Consulte también

System.Management.Automation.Parameterattribute

Nombres de parámetros de cmdlet

Escribir un cmdlet de Windows PowerShell