Dichiarazione della classe dei cmdlet

Una classe .NET Framework Microsoft viene dichiarata come cmdlet specificando l'attributo Cmdlet come metadati per la classe. L'attributo Cmdlet è l'unico attributo obbligatorio per tutti i cmdlet. Quando si specifica l'attributo Cmdlet, è necessario specificare la coppia verbo-sostantivo che identifica il cmdlet per l'utente. È inoltre necessario descrivere la Windows PowerShell funzionalità supportate dal cmdlet. Per altre informazioni sulla sintassi della dichiarazione usata per specificare l'attributo Cmdlet, vedere Dichiarazione dell'attributo cmdlet.

Nota

L'attributo Cmdlet è definito dalla classe System.Management.Automation.CmdletAttribute. Le proprietà di questa classe corrispondono ai parametri di dichiarazione usati quando si dichiara l'attributo .

Sostantivi

Il sostantivo del cmdlet specifica le risorse su cui agisce il cmdlet. Il sostantivo differenzia i cmdlet dagli altri cmdlet.

I nomi nei nomi dei cmdlet devono essere specifici e nel caso di sostantivi generici, ad esempio server, è meglio aggiungere un prefisso breve che differenzia la risorsa da altre risorse simili. Ad esempio, un nome di cmdlet che include un sostantivo con un prefisso è Get-SQLServer . La combinazione di un sostantivo specifico con un verbo più generale consente all'utente di individuare rapidamente il cmdlet in base all'azione e quindi identificare il cmdlet in base alla relativa risorsa evitando la duplicazione del nome del cmdlet non necessaria.

Per un elenco di caratteri speciali che non possono essere usati nei nomi dei cmdlet, vedere Linee guida per lo sviluppo obbligatorie.

Verbi

Quando si specifica un verbo, le linee guida per lo sviluppo richiedono l'uso di uno dei verbi predefiniti forniti da Windows PowerShell. Usando uno di questi verbi predefiniti, si garantirà la coerenza tra i cmdlet scritti e i cmdlet scritti da Microsoft e da altri. Ad esempio, il verbo "Get" viene usato per i cmdlet che recuperano dati.

Per altre informazioni sulle linee guida per i verbi, vedere Nomi dei verbi dei cmdlet. Per un elenco di caratteri speciali che non possono essere usati nei nomi dei cmdlet, vedere Linee guida per lo sviluppo obbligatorie.

Supporto di Windows PowerShell funzionalità

L'attributo Cmdlet consente anche di specificare che il cmdlet supporta alcune delle funzionalità comuni fornite da Windows PowerShell. Ciò include il supporto per funzionalità comuni, ad esempio la conferma del feedback dell'utente (definita supporto per la funzionalità ShouldProcess) e il supporto per le transazioni. Il supporto per le transazioni è stato introdotto in Windows PowerShell 2.0.

Per altre informazioni sulla sintassi della dichiarazione usata per specificare l'attributo Cmdlet, vedere Dichiarazione dell'attributo cmdlet.

Definizione della classe cmdlet

Il codice seguente è la definizione per una classe di cmdlet GetProc. Si noti che viene usata la distinzione tra maiuscole e minuscole Di Pascal e che il nome della classe include il verbo e il sostantivo del cmdlet.

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

Maiuscole/minuscole Di Pascal

Quando si denonono i cmdlet, usare la distinzione tra maiuscole e minuscole Di Pascal. Ad esempio, i cmdlet e mostrano il modo corretto per usare l'uso delle maiuscole quando Get-Item Get-ItemProperty si assegnano nomi ai cmdlet.

Vedere anche

System.Management.Automation.CmdletAttribute

Dichiarazione CmdletAttribute

Nomi dei verbi dei cmdlet

Scrittura di un cmdlet di Windows PowerShell

Windows PowerShell SDK