Declaratie van het kenmerk Cmdlet

  • Artikel

Het kenmerk Cmdlet identificeert een Microsoft .NET Framework-klasse als een cmdlet en specificeert het werkwoord en zelfstandig naamwoord dat wordt gebruikt om de cmdlet aan te roepen.

Syntaxis

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

Parameters

VerbName (System.String) Vereist. Hiermee geeft u de cmdlet werkwoord. Dit werkwoord geeft de actie aan die wordt ondernomen door de cmdlet . Zie Cmdlet Verb Names and Required Development Guidelines (Namen van cmdlet-woorden en vereiste ontwikkelingsrichtlijnen) voor meer informatie over goedgekeurde cmdlet-woorden.

NounName (System.String) Vereist. Hiermee geeft u het zelfstandig naamwoord cmdlet. Dit zelfstandig naamwoord geeft de resource aan waarop de cmdlet werkt. Zie Cmdlet-declaratie en Sterk aangemoedigde ontwikkelingsrichtlijnen voor meer informatie over cmdlet-zelfstandige naamwoorden.

SupportsShouldProcess (System.Boolean) Optionele benoemde parameter. True geeft aan dat de cmdlet ondersteuning biedt voor aanroepen naar de system.Management.Automation.Cmdlet.ShouldProcess-methode, waarmee de cmdlet een manier biedt om de gebruiker te vragen voordat een actie die het systeem wijzigt, wordt uitgevoerd. False, de standaardwaarde, geeft aan dat de cmdlet geen ondersteuning biedt voor aanroepen naar de methode System.Management.Automation.Cmdlet.ShouldProcess. Zie Bevestiging aanvragen voor meer informatie over bevestigingsaanvragen.

ConfirmImpact (System.Management.Automation.Confirmimpact) Optionele benoemde parameter. Hiermee geeft u op wanneer de actie van de cmdlet moet worden bevestigd door een aanroep van de methode System.Management.Automation.Cmdlet.ShouldProcess. 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 moet alleen worden opgegeven wanneer de SupportsShouldProcess parameter is opgegeven.

DefaultParameterSetName (System.String) Optionele benoemde parameter. Hiermee geeft u de standaardparameterset op die de Windows PowerShell runtime probeert te gebruiken wanneer niet kan worden bepaald welke parameterset moet worden gebruikt. U ziet dat deze situatie kan worden geëlimineerd door de unieke parameter van elke parameter een verplichte parameter te maken.

Er is één geval waarbij Windows PowerShell standaardparameterset niet kan gebruiken, zelfs niet als er een standaardnaam voor de parameterset is opgegeven. De Windows PowerShell kan geen onderscheid maken tussen parametersets die uitsluitend zijn gebaseerd op 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 is ingesteld voor gebruik op basis van de waarden die zijn doorgegeven aan de cmdlet en wordt de standaardparameterset niet gebruikt. In dit geval wordt, zelfs als u een standaardnaam voor de parameterset opgeeft, Windows PowerShell een dubbelzinnig foutbericht over de parameterset weergegeven.

SupportsTransactions (System.Boolean) Optionele benoemde parameter. True geeft aan dat de cmdlet kan worden gebruikt binnen een transactie. Wanneer is opgegeven, voegt Windows PowerShell parameter toe aan de True UseTransaction parameterlijst van de cmdlet. False, de standaardwaarde, geeft aan dat de cmdlet niet kan worden gebruikt binnen een transactie.

Opmerkingen

  • Samen worden de werkwoord en zelfstandig naamwoord gebruikt om uw geregistreerde cmdlet te identificeren en om uw cmdlet aan te roepen binnen een script.

  • Wanneer de cmdlet wordt aangeroepen vanuit de Windows PowerShell-console, lijkt de opdracht op de volgende opdracht:

VerbName-NounName

De Confirm WhatIf cmdlet-parameters en zijn alleen beschikbaar voor cmdlets die ondersteuning bieden voor aanroepen van System.Management.Automation.Cmdlet.ShouldProcess.

Voorbeeld

De volgende klassedefinitie maakt gebruik van het kenmerk Cmdlet om de .NET Framework-klasse voor een Get-Proc-cmdlet te identificeren die informatie op haalt over de processen die worden uitgevoerd op de lokale computer.

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

Zie GetProc Tutorial (GetProc-zelfstudie) voor meer informatie over de Get-Proc-cmdlet.

Zie ook

Een Windows PowerShell-cmdlet schrijven