Объявление класса командлета

класс платформа .NET Framework Microsoft объявляется как командлет, указывая атрибут командлета в качестве метаданных для класса. (Атрибут командлета является единственным обязательным атрибутом для всех командлетов). При указании атрибута командлета необходимо указать пару глагол-существительное, которая идентифицирует командлет для пользователя. и необходимо описать функциональные возможности Windows PowerShell, поддерживаемые командлетом. Дополнительные сведения о синтаксисе объявления, который используется для указания атрибута командлета , см. в разделе объявление атрибута командлета.

Примечание

Атрибут командлета определяется классом System. Management. Automation. CmdletAttribute . Свойства этого класса соответствуют параметрам объявления, которые используются при объявлении атрибута.

существительные;

Существительное командлет задает ресурсы, с которыми работает командлет. Существительное отличает командлеты от других командлетов.

Существительные в именах командлетов должны быть специфичными, а в случае универсальных существительных, таких как Server, лучше добавить короткий префикс, который отличает ресурс от других аналогичных ресурсов. Например, имя командлета, включающее существительное с префиксом, — Get-SQLServer . Сочетание определенного существительного с более общей командой позволяет пользователю быстро найти командлет по его действию, а затем указать командлет по его ресурсу, избегая дублирования имени командлета.

Список специальных символов, которые нельзя использовать в именах командлетов, см. в разделе необходимые рекомендации по разработке.

Команды

При указании глагола в руководствах по разработке необходимо использовать одну из предопределенных команд, предоставляемых Windows PowerShell. Используя одну из этих предопределенных команд, вы обеспечите согласованность между написанными командлетами и командлетами, написанными корпорацией Майкрософт и другими пользователями. Например, команда Get используется для командлетов, извлекающих данные.

Дополнительные сведения о рекомендациях для глаголов см. в разделе имена глаголов командлетов. Список специальных символов, которые нельзя использовать в именах командлетов, см. в разделе необходимые рекомендации по разработке.

поддержка функциональных возможностей Windows PowerShell

Атрибут командлета также позволяет указать, что командлет поддерживает некоторые общие функциональные возможности, предоставляемые Windows PowerShell. Сюда входит поддержка общих функциональных возможностей, таких как подтверждение отзывов пользователей (Эта функция называется поддержкой функции ShouldProcess) и поддержка транзакций. (поддержка транзакций была представлена в Windows PowerShell 2,0).

Дополнительные сведения о синтаксисе объявления, который используется для указания атрибута командлета , см. в разделе объявление атрибута командлета.

Определение класса командлета

Следующий код является определением для класса командлета proc. Обратите внимание, что используется регистр Pascal, а имя класса включает глагол и существительное командлета.

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

Регистр символов в стиле Pascal

При именовании командлетов используйте регистр символов в стиле Pascal. Например, Get-Item Get-ItemProperty командлеты и показывают правильный способ использования прописных букв при именовании командлетов.

См. также:

System. Management. Automation. CmdletAttribute

Объявление CmdletAttribute

Имена команд командлета

Запись командлета Windows PowerShell

Пакет SDK для Windows PowerShell