Parancsmagok attribútumdeklarációjaCmdlet Attribute Declaration

A parancsmag attribútum a Microsoft .NET Framework osztályt azonosítja parancsmagként, és megadja a parancsmag meghívásához használt műveletet és főnévi besorolást.The Cmdlet attribute identifies a Microsoft .NET Framework class as a cmdlet and specifies the verb and noun used to invoke the cmdlet.

SzintaxisSyntax

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

ParaméterekParameters

VerbName (System. String) megadása kötelező.VerbName (System.String) Required. Megadja a parancsmag műveletét.Specifies the cmdlet verb. Ez a művelet meghatározza a parancsmag által végrehajtott műveletet.This verb specifies the action taken by the cmdlet. További információ a jóváhagyott parancsmagokkal kapcsolatos műveletekről: parancsmag-műveletek nevei és a szükséges fejlesztési irányelvek.For more information about approved cmdlet verbs, see Cmdlet Verb Names and Required Development Guidelines.

NounName (System. String) megadása kötelező.NounName (System.String) Required. Meghatározza a parancsmagok főnévát.Specifies the cmdlet noun. Ez a főnév határozza meg azt az erőforrást, amelyet a parancsmag elvégez.This noun specifies the resource that the cmdlet acts upon. A parancsmag-nevekkel kapcsolatos további információkért lásd: parancsmag-deklaráció és erősen javasolt fejlesztési irányelvek.For more information about cmdlet nouns, see Cmdlet Declaration and Strongly Encouraged Development Guidelines.

SupportsShouldProcess (System. Boolean) választható elnevezett paraméter.SupportsShouldProcess (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag támogatja a System. Management. Automation. parancsmag. ShouldProcess metódus hívásait, amely lehetővé teszi a parancsmag számára, hogy a rendszer megváltoztatására szolgáló művelet előtt megkérdezze a felhasználót.True indicates that the cmdlet supports calls to the System.Management.Automation.Cmdlet.ShouldProcess method, which provides the cmdlet with a way to prompt the user before an action that changes the system is performed. Falseaz alapértelmezett érték azt jelzi, hogy a parancsmag nem támogatja a System. Management. Automation. parancsmag. ShouldProcess metódus hívásait.False, the default value, indicates that the cmdlet does not support calls to the System.Management.Automation.Cmdlet.ShouldProcess method. További információ a megerősítő kérésekről: megerősítés kérése.For more information about confirmation requests, see Requesting Confirmation.

ConfirmImpact (System. Management. Automation. Confirmimpact) az elnevezett paraméter nem kötelező.ConfirmImpact (System.Management.Automation.Confirmimpact) Optional named parameter. Megadja, hogy a parancsmag műveletét meg kell-e erősíteni a System. Management. Automation. parancsmag. ShouldProcess metódus meghívásával.Specifies when the action of the cmdlet should be confirmed by a call to the System.Management.Automation.Cmdlet.ShouldProcess method. A System. Management. Automation. parancsmag. ShouldProcess csak akkor lesz meghívva, ha a parancsmag ConfirmImpact értéke (alapértelmezés szerint közepes) egyenlő vagy nagyobb, mint a $ConfirmPreference változó értéke.System.Management.Automation.Cmdlet.ShouldProcess will only be called when the ConfirmImpact value of the cmdlet (by default, Medium) is equal to or greater than the value of the $ConfirmPreference variable. Ezt a paramétert csak akkor kell megadni SupportsShouldProcess , ha a paraméter meg van adva.This parameter should be specified only when the SupportsShouldProcess parameter is specified.

DefaultParameterSetName (System. String) választható elnevezett paraméter.DefaultParameterSetName (System.String) Optional named parameter. Azt az alapértelmezett paramétert adja meg, amelyet a Windows PowerShell-futtatókörnyezet akkor próbál használni, amikor nem tudja meghatározni, hogy melyik paramétert kell használni.Specifies the default parameter set that the Windows PowerShell runtime attempts to use when it cannot determine which parameter set to use. Figyelje meg, hogy ez a helyzet megkerülhető úgy, hogy az egyes paraméterek egyedi paramétere kötelező paramétert állít be.Notice that this situation can be eliminated by making the unique parameter of each parameter set a mandatory parameter.

Az egyik esetben, ha a Windows PowerShell nem tudja használni az alapértelmezett paramétert, még akkor is, ha meg van adva egy alapértelmezett paraméterérték neve.There is one case where Windows PowerShell cannot use the default parameter set even if a default parameter set name is specified. A Windows PowerShell futtatókörnyezet nem tudja megkülönböztetni a kizárólag az Objektumtípus alapján beállított paramétereket.The Windows PowerShell runtime cannot distinguish between parameter sets based solely on object type. Ha például egy olyan paraméter van beállítva, amely egy karakterláncot hoz létre a fájl elérési útjaként, és egy másik készletet, amely közvetlenül egy fileinfo objektumot fogad, a Windows PowerShell nem tudja meghatározni, hogy melyik paramétert kell használni a parancsmagnak átadott értékek alapján, és nem használja az alapértelmezett paramétert.For example, if you have one parameter set that takes a string as the file path, and another set that takes a FileInfo object directly, Windows PowerShell cannot determine which parameter set to use based on the values passed to the cmdlet, nor does it use the default parameter set. Ebben az esetben még akkor is, ha az alapértelmezett paraméterérték nevét adja meg, a Windows PowerShell egy nem egyértelmű paraméter-set hibaüzenetet jelenít meg.In this case, even if you specify a default parameter set name, Windows PowerShell throws an ambiguous parameter set error message.

SupportsTransactions (System. Boolean) választható elnevezett paraméter.SupportsTransactions (System.Boolean) Optional named parameter. True azt jelzi, hogy a parancsmag egy tranzakción belül használható.True indicates that the cmdlet can be used within a transaction. Ha meg True van adva, a Windows PowerShell futtatókörnyezet hozzáadja a UseTransaction paramétert a parancsmag paraméter-listájához.When True is specified, the Windows PowerShell runtime adds the UseTransaction parameter to the parameter list of the cmdlet. Falseaz alapértelmezett érték azt jelzi, hogy a parancsmag nem használható tranzakción belül.False, the default value, indicates that the cmdlet cannot be used within a transaction.

MegjegyzésekRemarks

  • A művelet és a főnév együttes használatával azonosíthatja a regisztrált parancsmagot, és meghívja a parancsmagot egy parancsfájlon belül.Together, the verb and noun are used to identify your registered cmdlet and to invoke your cmdlet within a script.

  • Ha a parancsmagot a Windows PowerShell-konzolról hívja meg, a parancs a következő parancshoz hasonlít:When the cmdlet is invoked from the Windows PowerShell console, the command resembles the following command:

VerbName-NounNameVerbName-NounName

A Confirm és a WhatIf parancsmag paraméterei csak a System. Management. Automation. parancsmag. ShouldProcess -hívásokat támogató parancsmagokhoz érhetők el.The Confirm and WhatIf cmdlet parameters are available only for cmdlets that support System.Management.Automation.Cmdlet.ShouldProcess calls.

PéldaExample

A következő osztály-definíció a parancsmag attribútum használatával azonosítja a .NET-keretrendszer osztályt a Get-proc parancsmaghoz, amely a helyi számítógépen futó folyamatokra vonatkozó információkat kér le.The following class definition uses the Cmdlet attribute to identify the .NET Framework class for a Get-Proc cmdlet that retrieves information about the processes running on the local computer.

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

További információ a Get-proc parancsmagról: GetProc- oktatóanyag.For more information about the Get-Proc cmdlet, see GetProc Tutorial.

Lásd még:See Also

Windows PowerShell-parancsmag írásaWriting a Windows PowerShell Cmdlet