Deklaration der Cmdlet-Klasse
Eine Microsoft .NET Framework-Klasse wird als Cmdlet deklariert, indem das Cmdlet-Attribut als Metadaten für die Klasse angegeben wird. (Das Cmdlet-Attribut ist das einzige erforderliche Attribut für alle Cmdlets.) Wenn Sie das Cmdlet-Attribut angeben, müssen Sie das Verb-Nomen-Paar angeben, das das Cmdlet für den Benutzer identifiziert. Außerdem müssen Sie die Windows PowerShell beschreiben, die das Cmdlet unterstützt. Weitere Informationen zur Deklarationssyntax, die zum Angeben des Cmdlet-Attributs verwendet wird, finden Sie unter Cmdlet-Attributdeklaration.
Hinweis
Das Cmdlet-Attribut wird von der System.Management.Automation.CmdletAttribute-Klasse definiert. Die Eigenschaften dieser Klasse entsprechen den Deklarationsparametern, die beim Deklarieren des Attributs verwendet werden.
Nomen
Das Nomen des Cmdlets gibt die Ressourcen an, für die das Cmdlet fungiert. Das Nomen unterscheidet Ihre Cmdlets von anderen Cmdlets.
Nomen in Cmdlet-Namen müssen spezifisch sein, und bei generischen Nomen, z. B. Server, ist es am besten, ein kurzes Präfix hinzuzufügen, das Ihre Ressource von anderen ähnlichen Ressourcen unterscheidet. Ein Cmdlet-Name, der ein Nomen mit einem Präfix enthält, ist beispielsweise Get-SQLServer . Die Kombination eines bestimmten Nomens mit einem allgemeineren Verb ermöglicht es dem Benutzer, das Cmdlet schnell durch seine Aktion zu finden und dann das Cmdlet nach seiner Ressource zu identifizieren und gleichzeitig unnötige Duplizierung von Cmdlet-Namen zu vermeiden.
Eine Liste der Sonderzeichen, die nicht in Cmdlet-Namen verwendet werden können, finden Sie unter Erforderliche Entwicklungsrichtlinien.
Verben
Wenn Sie ein Verb angeben, erfordern die Entwicklungsrichtlinien, dass Sie eines der vordefinierten Verben verwenden, die von Windows PowerShell. Indem Sie eines dieser vordefinierten Verben verwenden, stellen Sie die Konsistenz zwischen den cmdlets, die Sie schreiben, und den Cmdlets sicher, die von Microsoft und anderen geschrieben werden. Beispielsweise wird das Verb "Get" für Cmdlets verwendet, die Daten abrufen.
Weitere Informationen zu Richtlinien für Verben finden Sie unter Cmdlet Verb Names. Eine Liste der Sonderzeichen, die nicht in Cmdlet-Namen verwendet werden können, finden Sie unter Erforderliche Entwicklungsrichtlinien.
Unterstützen Windows PowerShell-Funktionalität
Mit dem Cmdlet-Attribut können Sie auch angeben, dass Ihr Cmdlet einige der allgemeinen Funktionen unterstützt, die von Windows PowerShell. Dies umfasst unterstützung für allgemeine Funktionen wie die Bestätigung von Benutzerfeedback (als Unterstützung für das ShouldProcess-Feature bezeichnet) und die Unterstützung von Transaktionen. (Die Unterstützung für Transaktionen wurde in Windows PowerShell 2.0 eingeführt.)
Weitere Informationen zur Deklarationssyntax, die zum Angeben des Cmdlet-Attributs verwendet wird, finden Sie unter Cmdlet-Attributdeklaration.
Cmdlet-Klassendefinition
Der folgende Code ist die Definition für eine GetProc-Cmdlet-Klasse. Beachten Sie, dass die Pascal-Schreibsprache verwendet wird und dass der Name der Klasse das Verb und das Substantiv des Cmdlets enthält.
[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet
Pascal-Groß-/Klein-/Klein-/
Verwenden Sie beim Benennen von Cmdlets die Pascal-Schreibsprache. Die Cmdlets und zeigen z. B. die richtige Methode zur Verwendung der Groß-/Groß-/A- beim Get-Item Get-ItemProperty Benennen von Cmdlets an.
Weitere Informationen
System.Management.Automation.CmdletAttribute