Cmdlet-klassdeklaration

En Microsoft .NET Framework-klass deklareras som en cmdlet genom att attributet Cmdlet anges som metadata för klassen. (Attributet Cmdlet är det enda obligatoriska attributet för alla cmdlets). När du anger cmdlet-attributet måste du ange det verb-och-substantivpar som identifierar cmdleten för användaren. Och du måste beskriva Windows PowerShell som cmdleten stöder. Mer information om deklarationssyntaxen som används för att ange attributet Cmdlet finns i Cmdlet Attribute Declaration.

Anteckning

Attributet Cmdlet definieras av klassen System.Management.Automation.CmdletAttribute. Egenskaperna för den här klassen motsvarar de deklarationsparametrar som används när du deklarerar attributet.

Substantiv

Substantivet för cmdleten anger de resurser som cmdleten agerar på. Substantivet skiljer dina cmdlets från andra cmdlets.

Substantiv i cmdlet-namn måste vara specifika, och när det gäller allmänna substantiv, till exempel server, är det bäst att lägga till ett kort prefix som skiljer din resurs från andra liknande resurser. Ett cmdlet-namn som innehåller ett substantiv med ett prefix är till exempel Get-SQLServer . Kombinationen av ett specifikt substantiv med ett mer allmänt verb gör det möjligt för användaren att snabbt hitta cmdleten genom åtgärden och sedan identifiera cmdleten med dess resurs samtidigt som onödig duplicering av cmdlet-namn undviks.

En lista över specialtecken som inte kan användas i cmdlet-namn finns i Nödvändiga riktlinjer för utveckling.

Verb

När du anger ett verb kräver utvecklingsriktlinjerna att du använder ett av de fördefinierade verb som tillhandahålls av Windows PowerShell. Genom att använda något av dessa fördefinierade verb säkerställer du konsekvensen mellan de cmdlets som du skriver och de cmdlets som skrivs av Microsoft och andra. Till exempel används verbet "Get" för cmdlets som hämtar data.

Mer information om riktlinjer för verb finns i Cmdlet verbnamn. En lista över specialtecken som inte kan användas i cmdlet-namn finns i Nödvändiga riktlinjer för utveckling.

Stöd Windows PowerShell funktioner

Med attributet Cmdlet kan du också ange att din cmdlet stöder några av de vanliga funktioner som tillhandahålls av Windows PowerShell. Detta inkluderar stöd för vanliga funktioner, till exempel bekräftelse av användarfeedback (kallas för stöd för funktionen ShouldProcess) och stöd för transaktioner. (Stöd för transaktioner introducerades i Windows PowerShell 2.0).

Mer information om deklarationssyntaxen som används för att ange attributet Cmdlet finns i Cmdlet Attribute Declaration.

Cmdlet-klassdefinition

Följande kod är definitionen för en GetProc-cmdlet-klass. Observera att Pascal-höljet används och att namnet på klassen innehåller verbet och substantivet för cmdleten.

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

Pascal-hölje

När du namntar cmdlets använder du Pascal-höljet. Cmdletarna Get-Item och visar till exempel rätt sätt att använda Get-ItemProperty versaler när du namnger cmdlets.

Se även

System.Management.Automation.CmdletAttribute

Deklaration av CmdletAttribute

Cmdlet-verbnamn

Skriva en Windows PowerShell-cmdlet

Windows PowerShell SDK