Как написать бинарный модуль PowerShell

Двоичным модулем может быть любая сборка (.dll), содержащая классы командлетов. По умолчанию все командлеты в сборке импортируются при импорте двоичного модуля. Тем не менее можно ограничить импортируемые командлеты, создав манифест модуля, корневым модулем которого является сборка. (Например, ключ CmdletsToExport манифеста можно использовать для экспорта только необходимых командлетов.) Кроме того, двоичный модуль может содержать дополнительные файлы, структуру каталогов и другие элементы полезных данных управления, которые не могут быть доступны для одного командлета.

В следующей процедуре описывается создание и установка двоичного модуля PowerShell.

Создание и установка двоичного модуля PowerShell

1. Создайте двоичное решение PowerShell (например, командлет, написанное на языке C#) с необходимыми возможностями и убедитесь, что оно работает правильно.

   С точки зрения кода ядро двоичного модуля — это просто сборка командлета. Фактически, PowerShell будет рассматривать одну сборку командлетов в качестве модуля с точки зрения загрузки и выгрузки без каких-либо дополнительных усилий в части разработчика. дополнительные сведения о написании командлета см. в разделе запись командлета Windows PowerShell.

2. При необходимости создайте остальную часть вашего решения: (Дополнительные командлеты, XML-файлы и т. д.) и опишите их с помощью манифеста модуля.

   Помимо описания сборок командлетов в решении, манифест модуля может описывать, как вы хотите экспортировать и импортировать модуль, какие командлеты будут предоставлены и какие дополнительные файлы будут помещены в модуль. Как уже отмечалось ранее, PowerShell может обрабатывать бинарный командлет, например модуль, без дополнительных усилий. Таким образом, манифест модуля полезен в основном для объединения нескольких файлов в один пакет или для явного управления публикацией для данной сборки. Дополнительные сведения см. в статье Создание манифеста модуля PowerShell.

   Следующий код является чрезвычайно простым блоком кода C#, который содержит три командлета в одном файле, который можно использовать в качестве модуля.

   using System.Management.Automation;           // Windows PowerShell namespace.
   
   namespace ModuleCmdlets
   {
     [Cmdlet(VerbsDiagnostic.Test,"BinaryModuleCmdlet1")]
     public class TestBinaryModuleCmdlet1Command : Cmdlet
     {
       protected override void BeginProcessing()
       {
         WriteObject("BinaryModuleCmdlet1 exported by the ModuleCmdlets module.");
       }
     }
   
     [Cmdlet(VerbsDiagnostic.Test, "BinaryModuleCmdlet2")]
     public class TestBinaryModuleCmdlet2Command : Cmdlet
     {
         protected override void BeginProcessing()
         {
             WriteObject("BinaryModuleCmdlet2 exported by the ModuleCmdlets module.");
         }
     }
   
     [Cmdlet(VerbsDiagnostic.Test, "BinaryModuleCmdlet3")]
     public class TestBinaryModuleCmdlet3Command : Cmdlet
     {
         protected override void BeginProcessing()
         {
             WriteObject("BinaryModuleCmdlet3 exported by the ModuleCmdlets module.");
         }
     }
   
   }
   

3. Упакуйте решение и сохраните пакет в другом месте в пути модуля PowerShell.

   PSModulePathГлобальная переменная среды описывает пути по умолчанию, которые PowerShell будет использовать для поиска вашего модуля. Например, общий путь для сохранения модуля в системе — %SystemRoot%\users\<user>\Documents\WindowsPowerShell\Modules\<moduleName> . Если вы не используете пути по умолчанию, необходимо явно указать расположение модуля во время установки. Не забудьте создать папку для сохранения модуля в, так как может потребоваться папка для хранения нескольких сборок и файлов для решения.

   Обратите внимание, что технически вам не нужно устанавливать модуль в любом месте PSModulePath — это просто расположения по умолчанию, которые PowerShell будет искать в вашем модуле. Однако рекомендуется использовать это решение, если нет веских причин для хранения модуля в другом месте. Дополнительные сведения см. в разделе Установка модуля PowerShell и about_PSModulePath.

4. Импортируйте модуль в PowerShell с помощью вызова Import-Module.

   Вызов командлета Import-Module приведет к загрузке модуля в активную память. Если вы используете PowerShell 3,0 и более поздней версии, просто вызвав имя модуля в коде, вы также импортируете его. Дополнительные сведения см. в разделе Импорт модуля PowerShell.

Импорт сборок оснастки в виде модулей

Командлеты и поставщики, существующие в сборках оснастки, можно загрузить как двоичные модули. Когда сборки оснастки загружаются в виде двоичных модулей, командлеты и поставщики в оснастке доступны пользователю, но класс оснастки в сборке игнорируется, а оснастка не зарегистрирована. в результате командлеты оснастки, предоставляемые Windows PowerShell, не могут обнаружить оснастку, даже если для сеанса доступны командлеты и поставщики.

Кроме того, любые файлы форматирования или типы, на которые ссылается оснастка, не могут быть импортированы как часть двоичного модуля. Чтобы импортировать файлы форматирования и типы, необходимо создать манифест модуля. См. раздел Создание манифеста модуля PowerShell.

См. также:

Написание модуля Windows PowerShell