Declaratie van het kenmerk Cmdlet
Het cmdlet-kenmerk identificeert een Microsoft .NET Framework-klasse als een cmdlet en geeft het werkwoord en zelfstandig naamwoord op dat wordt gebruikt om de cmdlet aan te roepen.
Syntaxis
[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]
Parameterwaarden
VerbName (System.String) Vereist. Hiermee geeft u de cmdlet-werkwoord. Met dit werkwoord geeft u de actie op die door de cmdlet wordt uitgevoerd. Zie Cmdlet Verb Names en Required Development Guidelinesvoor meer informatie over goedgekeurde cmdlet-werkwoorden.
NounName (System.String) Vereist. Hiermee geeft u het zelfstandig naamwoord van de cmdlet. Met dit zelfstandig naamwoord geeft u de resource op waarop de cmdlet reageert. Zie Cmdlet-declaratie en sterk aangemoedigde ontwikkelingsrichtlijnenvoor meer informatie over zelfstandige naamwoorden.
SupportsShouldProcess (System.Boolean) Optioneel benoemde parameter.
True geeft aan dat de cmdlet ondersteuning biedt voor aanroepen naar de methode System.Management.Automation.Cmdlet.ShouldProces s, die de cmdlet een manier biedt om de gebruiker te vragen voordat een actie wordt uitgevoerd die het systeem wijzigt.
False, de standaardwaarde, geeft aan dat de cmdlet geen ondersteuning biedt voor aanroepen naar de methode System.Management.Automation.Cmdlet.ShouldProcess. Zie Bevestigingsaanvraagvoor meer informatie over bevestigingsaanvragen.
ConfirmImpact (System.Management.Automation.ConfirmImpact) Optioneel benoemde parameter. Hiermee geeft u op wanneer de actie van de cmdlet moet worden bevestigd door een aanroep naar de System.Management.Automation.Cmdlet.ShouldProcess methode.
System.Management.Automation.Cmdlet.ShouldProcess wordt alleen aangeroepen wanneer de confirmImpact-waarde van de cmdlet (standaard gemiddeld) gelijk is aan of groter is dan de waarde van de $ConfirmPreference variabele. Deze parameter mag alleen worden opgegeven wanneer de parameter SupportsShouldProcess is opgegeven.
DefaultParameterSetName (System.String) Optioneel benoemde parameter. Hiermee geeft u de standaardparameterset op die de Windows PowerShell-runtime probeert te gebruiken wanneer deze niet kan bepalen welke parameter moet worden gebruikt. U ziet dat deze situatie kan worden geëlimineerd door de unieke parameter van elke parameter een verplichte parameter in te stellen.
Er is één geval waarin Windows PowerShell de standaardparameterset niet kan gebruiken, zelfs niet als een standaardparametersetnaam is opgegeven. De Windows PowerShell-runtime kan geen onderscheid maken tussen parametersets op basis van het objecttype. Als u bijvoorbeeld één parameterset hebt die een tekenreeks als bestandspad gebruikt en een andere set die rechtstreeks een FileInfo--object gebruikt, kan Windows PowerShell niet bepalen welke parameter moet worden gebruikt op basis van de waarden die aan de cmdlet zijn doorgegeven, noch wordt de standaardparameterset gebruikt. In dit geval genereert Windows PowerShell, zelfs als u een standaardnaam voor een parameterset opgeeft, een foutbericht over een niet-eenduidige parameterset.
SupportsTransactions (System.Boolean) Optioneel benoemde parameter.
True geeft aan dat de cmdlet kan worden gebruikt binnen een transactie. Wanneer True is opgegeven, voegt de Windows PowerShell-runtime de UseTransaction parameter toe aan de parameterlijst van de cmdlet.
False, de standaardwaarde, geeft aan dat de cmdlet niet kan worden gebruikt binnen een transactie.
Opmerkingen
Samen worden het werkwoord en zelfstandig naamwoord gebruikt om uw geregistreerde cmdlet te identificeren en uw cmdlet in een script aan te roepen.
Wanneer de cmdlet wordt aangeroepen vanuit de Windows PowerShell-console, lijkt de opdracht op de volgende opdracht:
VerbName-Zelfstandig naamwoordnaam
- Alle cmdlets die resources buiten Windows PowerShell wijzigen, moeten het
SupportsShouldProcesstrefwoord bevatten wanneer het cmdlet-kenmerk wordt gedeclareerd, zodat de cmdlet de System.Management.Automation.Cmdlet.ShouldProcess methode kan aanroepen voordat de cmdlet de actie uitvoert. Als de System.Management.Automation.Cmdlet.ShouldProcess aanroepfalseretourneert, moet de actie niet worden uitgevoerd. Zie Bevestigingsbevestiging aanvragenvoor meer informatie over de bevestigingsaanvragen die zijn gegenereerd door de System.Management.Automation.Cmdlet.ShouldProcess aanroep.
De parameters Confirm en WhatIf cmdlets zijn alleen beschikbaar voor cmdlets die ondersteuning bieden voor System.Management.Automation.Cmdlet.ShouldProcess aanroepen.
Voorbeeld
De volgende klassedefinitie maakt gebruik van het cmdlet-kenmerk om de .NET Framework-klasse te identificeren voor een Get-Proc cmdlet waarmee informatie wordt opgehaald over de processen die op de lokale computer worden uitgevoerd.
[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet
Zie GetProc Tutorialvoor meer informatie over de cmdlet Get-Proc.
