Cmdlet, deklaracja atrybutuCmdlet Attribute Declaration

Atrybut cmdlet identyfikuje klasę Microsoft .NET Framework jako polecenie cmdlet i określa czasownik i rzeczownik używany do wywołania polecenia cmdlet.The Cmdlet attribute identifies a Microsoft .NET Framework class as a cmdlet and specifies the verb and noun used to invoke the cmdlet.

SkładniaSyntax

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

ParametryParameters

VerbName (System. String) jest wymagany.VerbName (System.String) Required. Określa czasownik poleceń cmdlet.Specifies the cmdlet verb. To zlecenie określa akcję wykonywaną przez polecenie cmdlet.This verb specifies the action taken by the cmdlet. Aby uzyskać więcej informacji na temat zatwierdzonych zleceń poleceń cmdlet, zobacz nazwy zleceń poleceń cmdlet i wymagane wskazówki dotyczące programowania.For more information about approved cmdlet verbs, see Cmdlet Verb Names and Required Development Guidelines.

NounName (System. String) jest wymagany.NounName (System.String) Required. Określa rzeczownik poleceń cmdlet.Specifies the cmdlet noun. Ten rzeczownik określa zasób, na którym działa polecenie cmdlet.This noun specifies the resource that the cmdlet acts upon. Aby uzyskać więcej informacji na temat rzeczowników poleceń cmdlet, zobacz deklarację poleceń cmdlet i zdecydowanie zachęcamy do programowania.For more information about cmdlet nouns, see Cmdlet Declaration and Strongly Encouraged Development Guidelines.

SupportsShouldProcess (System. Boolean) opcjonalny nazwany parametr.SupportsShouldProcess (System.Boolean) Optional named parameter. True wskazuje, że polecenie cmdlet obsługuje wywołania metody System. Management. Automation. cmdlet. ShouldProcess , która udostępnia polecenie cmdlet z sposobem wyświetlania monitu użytkownika przed akcją, która zmienia system.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. Falsewartość domyślna wskazuje, że polecenie cmdlet nie obsługuje wywołań do metody System. Management. Automation. cmdlet. ShouldProcess .False, the default value, indicates that the cmdlet does not support calls to the System.Management.Automation.Cmdlet.ShouldProcess method. Aby uzyskać więcej informacji na temat żądań potwierdzenia, zobacz żądanie potwierdzenia.For more information about confirmation requests, see Requesting Confirmation.

ConfirmImpact (System. Management. Automation. Confirmimpact) opcjonalny nazwany parametr.ConfirmImpact (System.Management.Automation.Confirmimpact) Optional named parameter. Określa, kiedy Akcja polecenia cmdlet powinna zostać potwierdzona przez wywołanie metody System. Management. Automation. cmdlet. ShouldProcess .Specifies when the action of the cmdlet should be confirmed by a call to the System.Management.Automation.Cmdlet.ShouldProcess method. Funkcja System. Management. Automation. cmdlet. ShouldProcess zostanie wywołana tylko wtedy, gdy wartość ConfirmImpact polecenia cmdlet (domyślnie, średnia) jest równa lub większa niż wartość $ConfirmPreference zmiennej.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. Ten parametr należy określić tylko wtedy, gdy SupportsShouldProcess parametr jest określony.This parameter should be specified only when the SupportsShouldProcess parameter is specified.

DefaultParameterSetName (System. String) opcjonalny nazwany parametr.DefaultParameterSetName (System.String) Optional named parameter. Określa domyślny zestaw parametrów, który ma być używany przez środowisko uruchomieniowe programu Windows PowerShell, gdy nie może ustalić, który parametr ma być używany.Specifies the default parameter set that the Windows PowerShell runtime attempts to use when it cannot determine which parameter set to use. Należy zauważyć, że tę sytuację można wyeliminować, wprowadzając unikatowy parametr każdego parametru jako obowiązkowy parametr.Notice that this situation can be eliminated by making the unique parameter of each parameter set a mandatory parameter.

Istnieje jeden przypadek, w którym program Windows PowerShell nie może użyć domyślnego parametru, nawet jeśli określono domyślną nazwę zestawu parametrów.There is one case where Windows PowerShell cannot use the default parameter set even if a default parameter set name is specified. Środowisko uruchomieniowe programu Windows PowerShell nie może rozróżnić zestawów parametrów wyłącznie na podstawie typu obiektu.The Windows PowerShell runtime cannot distinguish between parameter sets based solely on object type. Na przykład jeśli masz jeden zestaw parametrów, który pobiera ciąg jako ścieżkę pliku i inny zestaw, który pobiera obiekt FileInfo bezpośrednio, program Windows PowerShell nie może określić, który parametr ma być używany na podstawie wartości przekazaną do polecenia cmdlet, ani nie używa domyślnego zestawu parametrów.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. W takim przypadku, nawet jeśli określisz domyślną nazwę zestawu parametrów, program Windows PowerShell zgłosi niejednoznaczny komunikat o błędzie zestawu parametrów.In this case, even if you specify a default parameter set name, Windows PowerShell throws an ambiguous parameter set error message.

SupportsTransactions (System. Boolean) opcjonalny nazwany parametr.SupportsTransactions (System.Boolean) Optional named parameter. True wskazuje, że polecenie cmdlet może być używane w ramach transakcji.True indicates that the cmdlet can be used within a transaction. Gdy True jest określony, środowisko uruchomieniowe programu Windows PowerShell dodaje UseTransaction parametr do listy parametrów polecenia cmdlet.When True is specified, the Windows PowerShell runtime adds the UseTransaction parameter to the parameter list of the cmdlet. Falsewartość domyślna wskazuje, że polecenia cmdlet nie można użyć w ramach transakcji.False, the default value, indicates that the cmdlet cannot be used within a transaction.

UwagiRemarks

  • Ze sobą czasownik i rzeczownik są używane do identyfikowania zarejestrowanego polecenia cmdlet i wywoływania polecenia cmdlet w skrypcie.Together, the verb and noun are used to identify your registered cmdlet and to invoke your cmdlet within a script.

  • Gdy polecenie cmdlet zostanie wywołane z poziomu konsoli programu Windows PowerShell, polecenie przypomina następujące polecenie:When the cmdlet is invoked from the Windows PowerShell console, the command resembles the following command:

Verbname-RzeczowniknameVerbName-NounName

Confirm WhatIf Parametry polecenia cmdlet i są dostępne tylko dla poleceń cmdlet, które obsługują wywołania System. Management. Automation. cmdlet. ShouldProcess .The Confirm and WhatIf cmdlet parameters are available only for cmdlets that support System.Management.Automation.Cmdlet.ShouldProcess calls.

PrzykładExample

Poniższa definicja klasy używa atrybutu cmdlet do identyfikowania klasy .NET Framework dla polecenia cmdlet Get-proc pobierającego informacje o procesach uruchomionych na komputerze lokalnym.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

Aby uzyskać więcej informacji na temat polecenia cmdlet Get-proc , zobacz getproc — samouczek.For more information about the Get-Proc cmdlet, see GetProc Tutorial.

Zobacz teżSee Also

Pisanie polecenia cmdlet programu Windows PowerShellWriting a Windows PowerShell Cmdlet