Cmdlet, deklaracja atrybutu
Atrybut polecenia cmdlet identyfikuje klasę Microsoft .NET Framework jako polecenie cmdlet i określa czasownik i rzeczownik używany do wywoływania polecenia cmdlet.
Składnia
[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]
Parametry
VerbName
(System.String) Wymagane. Określa czasownik polecenia cmdlet. To zlecenie określa akcję podjętą przez polecenie cmdlet . Aby uzyskać więcej informacji na temat zatwierdzonych czasowników polecenia cmdlet, zobacz Cmdlet Verb Names and Required Development Guidelines (Nazwy czasowników polecenia cmdlet i Wytyczne dotyczące projektowania wymaganych).
NounName
(System.String) Wymagane. Określa rzeczownik polecenia cmdlet. Ten rzeczownik określa zasób, na który działa polecenie cmdlet. Aby uzyskać więcej informacji na temat rzeczowników polecenia cmdlet, zobacz Deklaracja polecenia cmdlet i Wytyczne dotyczące zdecydowanie zalecanego projektowania.
SupportsShouldProcess
(System.Boolean) Opcjonalny nazwany parametr. True
wskazuje, że polecenie cmdlet obsługuje wywołania metody System.Management.Automation.Cmdlet.ShouldProcess, która udostępnia polecenie cmdlet w sposób monitowania użytkownika przed podjęciem akcji, która zmienia system. False
wartość domyślna wskazuje, że polecenie cmdlet nie obsługuje wywołań metody System.Management.Automation.Cmdlet.ShouldProcess. Aby uzyskać więcej informacji na temat żądań potwierdzenia, zobacz Żądanie potwierdzenia.
ConfirmImpact
(System.Management.Automation.Confirmimpact) Opcjonalny nazwany parametr. Określa, kiedy akcja polecenia cmdlet powinna zostać potwierdzone przez wywołanie metody System.Management.Automation.Cmdlet.ShouldProcess. System.Management.Automation.Cmdlet.ShouldProcess zostanie wywołany tylko wtedy, gdy wartość ConfirmImpact polecenia cmdlet (domyślnie Medium) jest równa lub większa niż wartość $ConfirmPreference
zmiennej. Ten parametr należy określić tylko wtedy, gdy SupportsShouldProcess
parametr jest określony.
DefaultParameterSetName
(System.String) Opcjonalny nazwany parametr. Określa domyślny zestaw parametrów, który Windows PowerShell środowisko uruchomieniowe próbuje użyć, gdy nie może określić, który parametr ma być ustawiony do użycia. Należy zauważyć, że tę sytuację można wyeliminować przez ustawienie unikatowego parametru każdego parametru jako parametru obowiązkowego.
Istnieje jeden przypadek, Windows PowerShell użyć domyślnego zestawu parametrów, nawet jeśli określono domyślną nazwę zestawu parametrów. Środowisko Windows PowerShell nie może rozróżnić zestawów parametrów wyłącznie na podstawie typu obiektu. Jeśli na przykład masz jeden zestaw parametrów, który przyjmuje ciąg jako ścieżkę pliku, i inny zestaw, który bezpośrednio przyjmuje obiekt FileInfo, program Windows PowerShell nie może określić, który parametr ma być ustawiony na podstawie wartości przekazanych do polecenia cmdlet, ani nie używa domyślnego zestawu parametrów. W takim przypadku, nawet jeśli określisz domyślną nazwę zestawu parametrów, Windows PowerShell zgłasza niejednoznaczny komunikat o błędzie zestawu parametrów.
SupportsTransactions
(System.Boolean) Opcjonalny nazwany parametr. True
wskazuje, że polecenie cmdlet może być używane w ramach transakcji. Gdy True
jest określony, środowisko Windows PowerShell dodaje UseTransaction
parametr do listy parametrów polecenia cmdlet. False
, wartość domyślna wskazuje, że nie można użyć polecenia cmdlet w ramach transakcji.
Uwagi
Razem czasownik i rzeczownik są używane do identyfikowania zarejestrowanego polecenia cmdlet i wywoływania polecenia cmdlet w skrypcie.
Gdy polecenie cmdlet jest wywoływane z konsoli Windows PowerShell, polecenie przypomina następujące polecenie:
VerbName-NounName
- Wszystkie polecenia cmdlet, które zmieniają zasoby poza usługą Windows PowerShell, powinny zawierać słowo kluczowe po zadeklarowaniu atrybutu polecenia cmdlet, co umożliwia polecenie cmdlet wywołanie metody
SupportsShouldProcess
System.Management.Automation.Cmdlet.ShouldProcess przed wykonaniem akcji przez polecenie cmdlet. Jeśli wywołanie System.Management.Automation.Cmdlet.ShouldProcess zwracafalse
wartość , nie należy tworzyć akcji. Aby uzyskać więcej informacji o żądaniach potwierdzenia generowanych przez wywołanie System.Management.Automation.Cmdlet.ShouldProcess, zobacz Żądanie potwierdzenia.
Parametry i polecenia cmdlet są dostępne tylko dla Confirm
WhatIf
cmdlet, które obsługują wywołania System.Management.Automation.Cmdlet.ShouldProcess.
Przykład
Następująca definicja klasy używa atrybutu polecenia cmdlet do identyfikowania klasy .NET Framework dla polecenia cmdlet Get-Proc, które pobiera informacje o procesach uruchomionych na komputerze lokalnym.
[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet
Aby uzyskać więcej informacji na temat polecenia cmdlet Get-Proc, zobacz GetProc Tutorial ( Samouczek GetProc).
Zobacz też
Opinia
https://aka.ms/ContentUserFeedback.
Już wkrótce: w ciągu 2024 r. będziemy stopniowo usuwać problemy z usługą GitHub jako mechanizm opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla