Cmdlet 类声明

通过将 Cmdlet 属性指定为类的元数据，可以将 Microsoft .NET Framework 类声明为 cmdlet。 （Cmdlet 属性是所有 cmdlet 唯一必需的属性）。指定 Cmdlet 属性时，必须指定向用户标识 cmdlet 的动词和名词对。并且，您必须描述 cmdlet 支持的 Windows PowerShell 功能。有关用于指定 Cmdlet 属性的声明语法的详细信息，请参阅 Cmdlet 属性声明。

笔记

Cmdlet 属性由 System.Management.Automation.CmdletAttribute 类定义。此类的属性对应于声明属性时使用的声明参数。

名词

cmdlet 的名词指定 cmdlet 所作用的资源。该名词将您的 cmdlet 与其他 cmdlet 区分开来。

cmdlet 名称中的名词必须是特定的，对于通用名词（例如服务器），最好添加一个简短的前缀，以将您的资源与其他类似资源区分开来。例如，包含前缀为 Get-SQLServer 的名词的 cmdlet 名称。特定名词与更通用动词的组合使用户能够通过其操作快速定位 cmdlet，然后通过其资源识别 cmdlet，同时避免不必要的 cmdlet 名称重复。

有关不能在 cmdlet 名称中使用的特殊字符的列表，请参阅所需的开发指南。

动词

当您指定动词时，开发指南要求您使用 Windows PowerShell 提供的预定义动词之一。通过使用这些预定义动词之一，您将确保您编写的 cmdlet 与 Microsoft 和其他人编写的 cmdlet 之间的一致性。例如，“Get”动词用于检索数据的 cmdlet。

有关动词准则的详细信息，请参阅 Cmdlet 动词名称。有关不能在 cmdlet 名称中使用的特殊字符的列表，请参阅所需的开发指南。

支持 Windows PowerShell 功能

Cmdlet 属性还允许您指定 cmdlet 支持 Windows PowerShell 提供的一些常见功能。这包括对常见功能的支持，例如用户反馈确认（称为对 ShouldProcess 功能的支持）和对事务的支持。 （Windows PowerShell 2.0 中引入了对事务的支持）。

有关用于指定 Cmdlet 属性的声明语法的详细信息，请参阅 Cmdlet 属性声明。

Cmdlet 类定义

以下代码是 GetProc cmdlet 类的定义。请注意，使用了 Pascal 大小写，并且类的名称包括 cmdlet 的动词和名词。

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

帕斯卡套管

命名 cmdlet 时，请使用 Pascal 大小写。例如，Get-Item 和 Get-ItemProperty cmdlet 显示了命名 cmdlet 时使用大写的正确方法。

参见

系统.管理.自动化.CmdletAttribute

Cmdlet属性声明

Cmdlet 动词名称

编写 Windows PowerShell Cmdlet

Windows PowerShell SDK