Deklarace atributu Cmdlet

Atribut Cmdlet identifikuje třídu Microsoft .NET Framework jako rutinu a určuje sloveso a podstatné jméno použité k vyvolání rutiny.

Syntaxe

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

Parametry

VerbName (System.String) Povinné. Určuje příkaz rutiny . Tento příkaz určuje akci provedenou rutinou . Další informace o schválených příkazech rutin najdete v tématu Názvy rutin a Pokyny pro požadovaný vývoj.

NounName (System.String) Povinné. Určuje podstatné jméno rutiny. Toto podstatné jméno určuje prostředek, se kterými rutina pracuje. Další informace o rutinách najdete v tématu Deklarace rutin a Pokyny pro vývoj se silnými doporučeními.

SupportsShouldProcess (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že rutina podporuje volání metody System.Management.Automation.Cmdlet.ShouldProcess, která poskytuje rutině způsob, jak uživatele vyzvat před provedením akce, která změní systém. False– výchozí hodnota označuje, že rutina nepodporuje volání metody System.Management.Automation.Cmdlet.ShouldProcess. Další informace o žádostech o potvrzení najdete v tématu Vyžádání potvrzení.

ConfirmImpact (System.Management.Automation.Confirmimpact) Volitelný pojmenovaný parametr. Určuje, kdy má být akce rutiny potvrzena voláním metody System.Management.Automation.Cmdlet.ShouldProcess. System.Management.Automation.Cmdlet.ShouldProcess bude volána pouze v případě, že je hodnota ConfirmImpact rutiny (ve výchozím nastavení Medium) rovna nebo větší než hodnota $ConfirmPreference proměnné. Tento parametr by měl být zadán pouze v SupportsShouldProcess případě, že je zadán parametr .

DefaultParameterSetName (System.String) Volitelný pojmenovaný parametr. Určuje výchozí sadu parametrů, kterou se Windows PowerShell runtime pokusí použít, když nemůže určit, která sada parametrů se má použít. Všimněte si, že tuto situaci lze eliminovat tak, že jedinečný parametr každého parametru nastavíte jako povinný parametr.

Existuje jeden případ, kdy Windows PowerShell použít výchozí sadu parametrů, i když je zadaný výchozí název sady parametrů. Modul runtime Windows PowerShell rozlišit mezi sadami parametrů výhradně na základě typu objektu. Pokud máte například jednu sadu parametrů, která přebírá řetězec jako cestu k souboru, a jiná sada, která přebírá přímo objekt FileInfo, nemůže Windows PowerShell určit, která sada parametrů se má použít, na základě hodnot předáých rutině, ani nebude používat výchozí sadu parametrů. V tomto případě i v případě, že zadáte výchozí název sady parametrů, Windows PowerShell chybová zpráva sady nejednoznačných parametrů.

SupportsTransactions (System.Boolean) Volitelný pojmenovaný parametr. True označuje, že rutinu lze použít v rámci transakce. Pokud je zadaný parametr, Windows PowerShell runtime přidá parametr do True seznamu parametrů UseTransaction rutiny. False, výchozí hodnota označuje, že rutinu nelze použít v rámci transakce.

Poznámky

  • Příkaz a podstatné jméno se společně používají k identifikaci registrované rutiny a k vyvolání rutiny ve skriptu.

  • Když se rutina vyvolá z Windows PowerShell, příkaz se podobá následujícímu příkazu:

VerbName-NounName

Parametry Confirm WhatIf rutin a jsou k dispozici pouze pro rutiny, které podporují volání System.Management.Automation.Cmdlet.ShouldProcess.

Příklad

Následující definice třídy používá atribut Cmdlet k identifikaci třídy .NET Framework pro rutinu Get-Proc, která načítá informace o procesech spuštěných v místním počítači.

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

Další informace o rutině Get-Proc najdete v tématu Kurz GetProc.

Viz také

Vytvoření rutiny Windows PowerShellu