Declaração de classe do cmdlet

Uma classe .NET Framework Microsoft é declarada como um cmdlet especificando o atributo Cmdlet como metadados para a classe . (O atributo Cmdlet é o único atributo necessário para todos os cmdlets). Ao especificar o atributo Cmdlet, você deve especificar o par verb-and-noun que identifica o cmdlet para o usuário. Além disso, você deve descrever a Windows PowerShell que o cmdlet dá suporte. Para obter mais informações sobre a sintaxe de declaração usada para especificar o atributo Cmdlet, consulte Declaração de atributo de cmdlet.

Observação

O atributo Cmdlet é definido pela classe System.Management.Automation.CmdletAttribute. As propriedades dessa classe correspondem aos parâmetros de declaração usados quando você declara o atributo.

Substantivos

O substantivo do cmdlet especifica os recursos nos quais o cmdlet atua. O substantivo diferencia seus cmdlets de outros cmdlets.

Substantivos em nomes de cmdlet devem ser específicos e, no caso de substantivos genéricos, como servidor , é melhor adicionar um prefixo curto que diferencie o recurso de outros recursos semelhantes. Por exemplo, um nome de cmdlet que inclui um substantivo com um prefixo é Get-SQLServer . A combinação de um substantivo específico com um verbo mais geral permite que o usuário localize rapidamente o cmdlet por sua ação e identifique o cmdlet por seu recurso, evitando a duplicação desnecessária do nome do cmdlet.

Para ver uma lista de caracteres especiais que não podem ser usados em nomes de cmdlet, consulte Diretrizes de desenvolvimento necessárias.

Verbos

Quando você especifica um verbo, as diretrizes de desenvolvimento exigem que você use um dos verbos predefinidos fornecidos pelo Windows PowerShell. Usando um desses verbos predefinidos, você garantirá a consistência entre os cmdlets que você escreve e os cmdlets gravados pela Microsoft e por outros. Por exemplo, o verbo "Get" é usado para cmdlets que recuperam dados.

Para obter mais informações sobre diretrizes para verbos, consulte Nomes de verbos do cmdlet. Para ver uma lista de caracteres especiais que não podem ser usados em nomes de cmdlet, consulte Diretrizes de desenvolvimento necessárias.

Suporte Windows PowerShell funcionalidade

O atributo Cmdlet também permite que você especifique que o cmdlet dá suporte a algumas das funcionalidades comuns fornecidas pelo Windows PowerShell. Isso inclui suporte para funcionalidades comuns, como confirmação de comentários do usuário (conhecida como suporte para o recurso ShouldProcess) e suporte para transações. (O suporte para transações foi introduzido Windows PowerShell 2.0).

Para obter mais informações sobre a sintaxe de declaração usada para especificar o atributo Cmdlet, consulte Declaração de atributo de cmdlet.

Definição de classe de cmdlet

O código a seguir é a definição de uma classe de cmdlet GetProc. Observe que Pascal casing é usado e que o nome da classe inclui o verbo e o substantivo do cmdlet.

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

Pascal Casing

Quando você nomeia cmdlets, use o uso de uso de caixa de dados Pascal. Por exemplo, os cmdlets e mostram a maneira correta de usar Get-Item Get-ItemProperty a capitalização quando você está nomeando cmdlets.

Consulte Também

System.Management.Automation.CmdletAttribute

Declaração cmdletAttribute

Nomes de verbos do cmdlet

Writing a Windows PowerShell Cmdlet (Escrevendo um Cmdlet do Windows PowerShell)

SDK do Windows PowerShell