Deklaracja klasy polecenia cmdlet

  • Artykuł

Klasa Microsoft .NET Framework jest zadeklarowana jako polecenie cmdlet, określając atrybut polecenia cmdlet jako metadane dla klasy. (Atrybut polecenia cmdlet jest jedynym wymaganym atrybutem dla wszystkich polecenia cmdlet). Podczas określania atrybutu polecenia cmdlet należy określić parę czasownik-i-rzeczownik, która identyfikuje polecenie cmdlet użytkownikowi. Należy również opisać funkcje Windows PowerShell, które obsługuje polecenie cmdlet. Aby uzyskać więcej informacji na temat składni deklaracji używanej do określania atrybutu polecenia cmdlet, zobacz Deklaracja atrybutu polecenia cmdlet.

Uwaga

Atrybut polecenia cmdlet jest definiowany przez klasę System.Management.Automation.CmdletAttribute. Właściwości tej klasy odpowiadają parametrom deklaracji, które są używane podczas deklarowania atrybutu.

Rzeczowniki

Rzeczownik polecenia cmdlet określa zasoby, na których działa polecenie cmdlet. Rzeczownik odróżnia polecenia cmdlet od innych.

Rzeczowniki w nazwach polecenia cmdlet muszą być specyficzne, a w przypadku rzeczowników ogólnych, takich jak server , najlepiej jest dodać krótki prefiks, który odróżnia zasób od innych podobnych zasobów. Na przykład nazwa polecenia cmdlet, która zawiera rzeczownik z prefiksem, to Get-SQLServer . Kombinacja określonego rzeczownika z bardziej ogólnym czasownikiem umożliwia użytkownikowi szybkie zlokalizowanie polecenia cmdlet przez jego akcję, a następnie zidentyfikowanie polecenia cmdlet według jego zasobu przy jednoczesnym uniknięciu niepotrzebnego duplikowania nazw polecenia cmdlet.

Aby uzyskać listę znaków specjalnych, których nie można używać w nazwach polecenia cmdlet, zobacz Required Development Guidelines.

zlecenia

Po określeniu zlecenia wytyczne dotyczące tworzenia aplikacji wymagają użycia jednego ze wstępnie zdefiniowanych czasowników dostarczonych przez Windows PowerShell. Korzystając z jednego z tych wstępnie zdefiniowanych czasowników, zapewnisz spójność między zapisanymi poleceniami cmdlet a poleceniami cmdlet napisanymi przez firmę Microsoft i inne osoby. Na przykład czasownik "Get" jest używany dla polecenia cmdlet, które pobierają dane.

Aby uzyskać więcej informacji na temat wytycznych dotyczących czasowników, zobacz Nazwy czasowników polecenia cmdlet. Aby uzyskać listę znaków specjalnych, których nie można używać w nazwach polecenia cmdlet, zobacz Required Development Guidelines.

Obsługa Windows PowerShell danych

Atrybut polecenia cmdlet umożliwia również określenie, że polecenie cmdlet obsługuje niektóre typowe funkcje udostępniane przez Windows PowerShell. Obejmuje to obsługę typowych funkcji, takich jak potwierdzanie opinii użytkowników (określane jako obsługa funkcji ShouldProcess) i obsługa transakcji. (Obsługa transakcji została wprowadzona w Windows PowerShell 2.0).

Aby uzyskać więcej informacji na temat składni deklaracji używanej do określania atrybutu polecenia cmdlet, zobacz Deklaracja atrybutu polecenia cmdlet.

Definicja klasy polecenia cmdlet

Poniższy kod jest definicją klasy polecenia cmdlet GetProc. Zwróć uwagę, że jest używana nazwa pascali i że nazwa klasy zawiera czasownik i rzeczownik polecenia cmdlet.

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

Pascal Casing

Podczas nazywania polecenia cmdlet użyj wielkością kropki Pascal. Na przykład polecenia cmdlet i pokazują prawidłowy sposób używania liter podczas nadawania nazw Get-Item Get-ItemProperty poleceniam cmdlet.

Zobacz też

System.Management.Automation.CmdletAttribute

Deklaracja CmdletAttribute

Nazwy czasowników polecenia cmdlet

Pisanie polecenia cmdlet programu Windows PowerShell

Windows PowerShell SDK