Deklaration av attributet Cmdlet

Attributet Cmdlet identifierar en Microsoft .NET Framework-klass som en cmdlet och anger verbet och substantivet som används för att anropa cmdleten.

Syntax

[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]

Parametrar

VerbName (System.String) Krävs. Anger cmdlet-verbet. Det här verbet anger den åtgärd som vidtas av cmdleten . Mer information om godkända cmdlet-verb finns i Cmdlet Verb Names (Cmdlet-verbnamn) och Required Development Guidelines (Nödvändiga riktlinjer för utveckling).

NounName (System.String) Krävs. Anger cmdlet-substantivet. Det här substantivet anger den resurs som cmdleten agerar på. Mer information om cmdlet-substantiv finns i Cmdlet-deklaration och Starkt uppmuntrade riktlinjer för utveckling.

SupportsShouldProcess (System.Boolean) Valfri namngiven parameter. True anger att cmdleten stöder anrop till metoden System.Management.Automation.Cmdlet.ShouldProcess, som ger cmdleten ett sätt att fråga användaren innan en åtgärd som ändrar systemet utförs. False, standardvärdet, anger att cmdleten inte stöder anrop till metoden System.Management.Automation.Cmdlet.ShouldProcess. Mer information om bekräftelsebegäranden finns i Begära bekräftelse.

ConfirmImpact (System.Management.Automation.Confirmimpact) Valfri namngiven parameter. Anger när åtgärden för cmdleten ska bekräftas av ett anrop till metoden System.Management.Automation.Cmdlet.ShouldProcess. System.Management.Automation.Cmdlet.ShouldProcess anropas bara när värdet ConfirmImpact för cmdleten (som standard Medel) är lika med eller större än värdet för $ConfirmPreference variabeln. Den här parametern ska bara anges när SupportsShouldProcess parametern anges.

DefaultParameterSetName (System.String) Valfri namngiven parameter. Anger standardparameteruppsättningen som Windows PowerShell försöker använda när den inte kan avgöra vilken parameter som ska användas. Observera att den här situationen kan elimineras genom att göra den unika parametern för varje parameteruppsättning till en obligatorisk parameter.

Det finns ett fall där Windows PowerShell kan använda standardparameteruppsättningen även om ett standardnamn för parameteruppsättningen har angetts. Körningen Windows PowerShell kan inte skilja mellan parameteruppsättningar enbart baserat på objekttypen. Om du till exempel har en parameteruppsättning som tar en sträng som sökväg och en annan uppsättning som tar ett FileInfo-objekt direkt, kan Windows PowerShell inte avgöra vilken parameteruppsättning som ska användas baserat på de värden som skickas till cmdleten, och den använder inte heller standardparameteruppsättningen. I det här fallet, även om du anger ett standardnamn för parameteruppsättningen, Windows PowerShell ett tvetydigt felmeddelande om parameteruppsättningen.

SupportsTransactions (System.Boolean) Valfri namngiven parameter. True anger att cmdleten kan användas i en transaktion. När True anges lägger Windows PowerShell till UseTransaction parametern i cmdletens parameterlista. False, standardvärdet, anger att cmdleten inte kan användas i en transaktion.

Kommentarer

  • Tillsammans används verbet och substantivet för att identifiera din registrerade cmdlet och för att anropa din cmdlet i ett skript.

  • När cmdleten anropas från Windows PowerShell-konsolen liknar kommandot följande kommando:

VerbName-NounName

Cmdlet-parametrarna och är bara tillgängliga för cmdlet:ar som stöder Confirm WhatIf anropen System.Management.Automation.Cmdlet.ShouldProcess.

Exempel

Följande klassdefinition använder attributet Cmdlet för att identifiera .NET Framework-klassen för en Get-Proc-cmdlet som hämtar information om de processer som körs på den lokala datorn.

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

Mer information om cmdleten Get-Proc finns i GetProc Tutorial.

Se även

Skriva en Windows PowerShell-cmdlet