Declaración de clase del cmdletCmdlet Class Declaration

Una clase de marco de Microsoft .NET se declara como un cmdlet especificando el atributo del cmdlet como metadatos para la clase.A Microsoft .NET Framework class is declared as a cmdlet by specifying the Cmdlet attribute as metadata for the class. (El atributo cmdlet es el único atributo necesario para todos los cmdlets).(The Cmdlet attribute is the only required attribute for all cmdlets). Al especificar el atributo del cmdlet , debe especificar el par verbo-y-sustantivo que identifica el cmdlet para el usuario.When you specify the Cmdlet attribute, you must specify the verb-and-noun pair that identifies the cmdlet to the user. Además, debe describir la funcionalidad de Windows PowerShell que admite el cmdlet.And, you must describe the Windows PowerShell functionality that the cmdlet supports. Para obtener más información sobre la sintaxis de declaración que se usa para especificar el atributo de cmdlet , vea declaración de atributo de cmdlet.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Nota

El atributo cmdlet se define mediante la clase System. Management. Automation. CmdletAttribute .The Cmdlet attribute is defined by the System.Management.Automation.CmdletAttribute class. Las propiedades de esta clase corresponden a los parámetros de declaración que se utilizan al declarar el atributo.The properties of this class correspond to the declaration parameters that are used when you declare the attribute.

SustantivosNouns

El nombre del cmdlet especifica los recursos en los que actúa el cmdlet.The noun of the cmdlet specifies the resources upon which the cmdlet acts. El nombre diferencia los cmdlets de otros cmdlets.The noun differentiates your cmdlets from other cmdlets.

Los nombres de los nombres de cmdlet deben ser específicos y, en el caso de nombres genéricos, como Server, es mejor agregar un prefijo corto que diferencie el recurso de otros recursos similares.Nouns in cmdlet names must be specific, and in the case of generic nouns, such as server, it is best to add a short prefix that differentiates your resource from other similar resources. Por ejemplo, un nombre de cmdlet que incluye un sustantivo con un prefijo es Get-SQLServer .For example, a cmdlet name that includes a noun with a prefix is 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 y evitar la duplicación de nombres de cmdlets innecesarios.The combination of a specific noun with a more general verb enables the user to quickly locate the cmdlet by its action and then identify the cmdlet by its resource while avoiding unnecessary cmdlet name duplication.

Para obtener una lista de los caracteres especiales que no se pueden usar en los nombres de cmdlet, consulte las directrices de desarrollo necesarias.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

VerbosVerbs

Cuando se especifica un verbo, las instrucciones de desarrollo requieren el uso de uno de los verbos predefinidos proporcionados por Windows PowerShell.When you specify a verb, the development guidelines require you to use one of the predefined verbs provided by Windows PowerShell. Al usar uno de estos verbos predefinidos, se garantiza la coherencia entre los cmdlets que se escriben y los cmdlets escritos por Microsoft y por otros usuarios.By using one of these predefined verbs, you will ensure consistency between the cmdlets that you write and the cmdlets that are written by Microsoft and by others. Por ejemplo, el verbo "Get" se usa para los cmdlets que recuperan datos.For example, the "Get" verb is used for cmdlets that retrieve data.

Para obtener más información sobre las directrices para los verbos, consulte nombres de verbos de cmdlet.For more information about guidelines for verbs, see Cmdlet Verb Names. Para obtener una lista de los caracteres especiales que no se pueden usar en los nombres de cmdlet, consulte las directrices de desarrollo necesarias.For a list of special characters that cannot be used in cmdlet names, see Required Development Guidelines.

Compatibilidad con la funcionalidad de Windows PowerShellSupporting Windows PowerShell Functionality

El atributo cmdlet también le permite especificar que el cmdlet admite parte de la funcionalidad común proporcionada por Windows PowerShell.The Cmdlet attribute also allows you to specify that your cmdlet supports some of the common functionality that is provided by Windows PowerShell. Esto incluye compatibilidad con la funcionalidad común, como la confirmación de comentarios de usuario (denominada compatibilidad con la característica ShouldProcess) y la compatibilidad con transacciones.This includes support for common functionality such as user feedback confirmation (referred to as support for the ShouldProcess feature) and support for transactions. (La compatibilidad con transacciones se presentó en Windows PowerShell 2,0).(Support for transactions was introduced in Windows PowerShell 2.0).

Para obtener más información sobre la sintaxis de declaración que se usa para especificar el atributo de cmdlet , vea declaración de atributo de cmdlet.For more information about the declaration syntax that is used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.

Definición de clase de cmdletCmdlet Class Definition

El código siguiente es la definición de una clase de cmdlet de GetProc.The following code is the definition for a GetProc cmdlet class. Observe que se usa la grafía Pascal y que el nombre de la clase incluye el verbo y el nombre del cmdlet.Notice that Pascal casing is used and that the name of the class includes the verb and noun of the cmdlet.

[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet

Mayúsculas y minúsculas PascalPascal Casing

Cuando asigne nombre a los cmdlets, utilice la grafía Pascal.When you name cmdlets, use Pascal casing. Por ejemplo, los Get-Item Get-ItemProperty cmdlets y muestran la manera correcta de usar las mayúsculas y minúsculas cuando se asignan nombres a los cmdlets.For example, the Get-Item and Get-ItemProperty cmdlets show the correct way to use capitalization when you are naming cmdlets.

Consulte tambiénSee Also

System. Management. Automation. CmdletAttributeSystem.Management.Automation.CmdletAttribute

Declaración de CmdletAttributeCmdletAttribute Declaration

Nombres de verbo de cmdletCmdlet Verb Names

Escribir un cmdlet de Windows PowerShellWriting a Windows PowerShell Cmdlet

Windows PowerShell SDKWindows PowerShell SDK