Parancsmagok attribútumdeklarációja

  • Cikk

A Parancsmag attribútum egy Microsoft .NET-keretrendszer osztályt azonosít parancsmagként, és megadja a parancsmag meghívásának műveletét és főnevét.

Szintaxis

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

Paraméterek

VerbName (System.String) Kötelező. Megadja a parancsmag parancsmagját. Ez a parancsmag által tett műveletet határozza meg. A jóváhagyott parancsmag-parancsmagokkal kapcsolatos további információkért lásd a parancsmagok parancsmagneveit és a szükséges fejlesztési irányelveket.

NounName (System.String) Kötelező. Megadja a parancsmag főnévét. Ez a főnév azt az erőforrást határozza meg, amely alapján a parancsmag viselkedik. A parancsmagok főnévivel kapcsolatos további információkért lásd: Parancsmag-deklaráció és erősen ajánlott fejlesztési irányelvek.

SupportsShouldProcess (System.Boolean) Nem kötelező nevesult paraméter. True A azt jelzi, hogy a parancsmag támogatja a System.Management.Automation.Cmdlet.ShouldProcess metódus hívását, amely lehetővé teszi a parancsmagnak, hogy a rendszer egy műveletet megelőzően rákérdez a felhasználóra a rendszert megváltoztató művelet előtt. False, az alapértelmezett érték azt jelzi, hogy a parancsmag nem támogatja a System.Management.Automation.Cmdlet.ShouldProcess metódushoz való hívásokat. A megerősítési kérésekkel kapcsolatos további információkért lásd: Megerősítés kérése.

ConfirmImpact (System.Management.Automation.Confirmimpact) Nem kötelező elnevezett paraméter. Megadja, hogy a parancsmag műveletét mikor kell megerősíteni a System.Management.Automation.Cmdlet.ShouldProcess metódus hívásával. A System.Management.Automation.Cmdlet.ShouldProcess csak akkor lesz meghívva, ha a parancsmag ConfirmImpact értéke (alapértelmezés szerint Közepes) egyenlő vagy nagyobb, mint a változó $ConfirmPreference értéke. Ezt a paramétert csak akkor kell megadni, ha SupportsShouldProcess a paraméter meg van adva.

DefaultParameterSetName (System.String) Nem kötelező nevesult paraméter. Megadja azt az alapértelmezett paraméterkészletet, amelyet a Windows PowerShell futásidejű futtatás megpróbál használni, ha nem tudja meghatározni, hogy melyik paraméterkészletet használja. Figyelje meg, hogy ez a helyzet kiküszöbölhető, ha minden paraméterkészlet egyedi paraméterét kötelező paraméterként adja meg.

Van egy eset, Windows PowerShell nem használhatja az alapértelmezett paraméterkészletet, még akkor sem, ha az alapértelmezett paraméterkészlet neve meg van adva. A Windows PowerShell nem tudja megkülönböztetni a paraméterkészleteket kizárólag az objektumtípus alapján. Ha például egy olyan paraméterkészlettel rendelkezik, amely sztringet használ a fájl elérési útjaként, és egy másik készlet, amely közvetlenül egy FileInfo objektumot használ, a Windows PowerShell nem tudja meghatározni, hogy melyik paraméterkészletet használja a parancsmagnak átadott értékek alapján, és nem használja az alapértelmezett paraméterkészletet. Ebben az esetben még ha megad is egy alapértelmezett paraméterkészlet-nevet, a Windows PowerShell egy nem egyértelmű paraméterkészlet-hibaüzenetet ad vissza.

SupportsTransactions (System.Boolean) Nem kötelező nevesult paraméter. True Azt jelzi, hogy a parancsmag tranzakción belül használható. Ha meg van adva, Windows PowerShell a runtime hozzáadja a paramétert a True UseTransaction parancsmag paraméterlistához. Falseaz alapértelmezett érték azt jelzi, hogy a parancsmag nem használható tranzakción belül.

Megjegyzések

  • A rendszer az ige és a főnév együttes használatával azonosítja a regisztrált parancsmagot, és meghívja a parancsmagot egy szkriptben.

  • Amikor a parancsmagot a Windows PowerShell konzolról hívja meg, a parancs a következő parancshoz lesz hasonló:

VerbName-NounName

A Confirm és a parancsmagparaméter csak a WhatIf System.Management.Automation.Cmdlet.ShouldProcess hívásokat támogató parancsmagok esetén érhető el.

Példa

A következő osztálydefiníció a Cmdlet attribútummal azonosítja a .NET-keretrendszer osztályt egy Olyan Get-Proc parancsmaghoz, amely információkat szerez be a helyi számítógépen futó folyamatokról.

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

További információ a Get-Proc parancsmagról: GetProc-oktatóanyag.

Lásd még:

Windows PowerShell-parancsmag írása