Declaración de clase del cmdlet
Una clase .NET Framework microsoft se declara como un cmdlet especificando el atributo Cmdlet como metadatos para la clase . (El atributo cmdlet es el único atributo necesario para todos los cmdlets). Al especificar el atributo Cmdlet, debe especificar el par verbo-y-nombre que identifica el cmdlet al usuario. Además, debe describir la funcionalidad de Windows PowerShell que admite el cmdlet . Para obtener más información sobre la sintaxis de declaración que se usa para especificar el atributo Cmdlet, vea Declaración de atributo de cmdlet.
Nota
La clase System.Management.Automation.CmdletAttribute define el atributo Cmdlet. Las propiedades de esta clase corresponden a los parámetros de declaración que se usan al declarar el atributo.
Sustantivos
El nombre del cmdlet especifica los recursos sobre los que actúa el cmdlet. El sustantivo diferencia los cmdlets de otros cmdlets.
Los nombres de los nombres de cmdlet deben ser específicos y, en el caso de nombres genéricos, como el servidor , es mejor agregar un prefijo corto que diferencie el recurso de otros recursos similares. Por ejemplo, un nombre de cmdlet que incluye un sustantivo con un prefijo es Get-SQLServer . La combinación de un sustantivo específico con un verbo más general permite al usuario localizar rápidamente el cmdlet por su acción y, a continuación, identificar el cmdlet por su recurso, al tiempo que evita la duplicación innecesaria del nombre del cmdlet.
Para obtener una lista de caracteres especiales que no se pueden usar en nombres de cmdlet, vea Instrucciones de desarrollo necesarias.
Verbos
Al especificar un verbo, las directrices de desarrollo requieren que se use uno de los verbos predefinidos proporcionados por Windows PowerShell. Mediante el uso de uno de estos verbos predefinidos, garantizará la coherencia entre los cmdlets que escribe y los cmdlets escritos por Microsoft y otros. Por ejemplo, el verbo "Get" se usa para los cmdlets que recuperan datos.
Para obtener más información sobre las directrices para verbos, vea Nombres de verbos de cmdlet. Para obtener una lista de caracteres especiales que no se pueden usar en nombres de cmdlet, vea Instrucciones de desarrollo necesarias.
Compatibilidad con Windows PowerShell funcionalidad
El atributo Cmdlet también permite especificar que el cmdlet admite algunas de las funcionalidades comunes que proporciona Windows PowerShell. Esto incluye compatibilidad con funcionalidades comunes, como la confirmación de comentarios del usuario (denominada compatibilidad con la característica ShouldProcess) y la compatibilidad con transacciones. (La compatibilidad con transacciones se introdujo en Windows PowerShell 2.0).
Para obtener más información sobre la sintaxis de declaración que se usa para especificar el atributo Cmdlet, vea Declaración de atributo de cmdlet.
Definición de clase de cmdlet
El código siguiente es la definición de una clase de cmdlet GetProc. Observe que se usa el uso de mayúsculas y minúsculas Pascal y que el nombre de la clase incluye el verbo y el nombre del cmdlet.
[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet
Mayúsculas y minúsculas Pascal
Cuando asigne un nombre a los cmdlets, use mayúsculas y minúsculas Pascal. Por ejemplo, los cmdlets y muestran la manera correcta de usar mayúsculas y mayúsculas al asignar Get-Item nombres a los Get-ItemProperty cmdlets.
Consulte también
System.Management.Automation.CmdletAttribute
Declaración de CmdletAttribute
Comentarios
Próximamente: a lo largo de 2024, eliminaremos gradualmente los problemas de GitHub como mecanismo de comentarios para el contenido y lo reemplazaremos por un nuevo sistema de comentarios. Para obtener más información, consulte: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de