Модуль community.windows.win_psmodule_info – сбор информации о модулях PowerShell

name

string

Имя извлекаемого модуля.

Поддерживаются любые шаблоны подстановочных знаков, поддерживаемые Get-Module.

Если параметр не указан, будут возвращены все модули.

По умолчанию: "*"

repository

string

Имя репозитория PSRepository, из которого установлены модули.

Этот параметр фильтрует модули, возвращаемые с учетом параметра name.

Если этот параметр задан, модули, установленные не из репозитория, возвращены не будут.

Будут возвращены только модули, установленные из зарегистрированного репозитория.

Если после установки модуля репозиторий был зарегистрирован повторно с новым значением SourceLocation, соответствия не будет.

modules

list / elements=dictionary

Список модулей (или пустой список, если их нет).

Возвращается: всегда

access_mode

string

Режим доступа модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.moduleaccessmode

Возвращается: при успехе

Пример: "ReadWrite"

author

string

Автор модуля.

Возвращается: при успехе

Пример: "Warren Frame"

clr_version

string

Версия CLR модуля.

Возвращается: при успехе

Пример: "4.0"

company_name

string

Название компании — разработчика модуля.

Возвращается: при успехе

Пример: "Microsoft Corporation"

compatible_ps_editions

list / elements=string

Редакции PowerShell, с которыми совместим модуль.

Возвращается: при успехе

Пример: ["Desktop"]

copyright

string

Информация об авторских правах на модуль.

Возвращается: при успехе

Пример: "(c) 2016 Warren F. All rights reserved."

dependencies

list / elements=string

Модули, необходимые этому модулю.

Возвращается: при успехе

description

string

Описание модуля.

Возвращается: при успехе

Пример: "Provides cmdlets to work with local users and local groups"

dot_net_framework_version

string

Версия .Net Framework модуля.

Возвращается: при успехе

Пример: "4.6.1"

exported_aliases

list / elements=string

Псевдонимы, экспортируемые модулем.

Возвращается: при успехе

Пример: ["glu", "slu"]

exported_cmdlets

list / elements=string

Командлеты, экспортируемые модулем.

Возвращается: при успехе

Пример: ["Get-Certificate", "Get-PfxData"]

exported_commands

list / elements=string

Все команды, экспортируемые модулем, включая функции, командлеты и псевдонимы.

Возвращается: при успехе

Пример: ["glu", "Get-LocalUser"]

exported_dsc_resources

list / elements=string

Ресурсы DSC, экспортируемые модулем.

Возвращается: при успехе

Пример: ["xWebAppPool", "xWebSite"]

exported_format_files

list / elements=path

Файлы форматирования, экспортируемые модулем.

Возвращается: при успехе

Пример: ["C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsCmdlets.Format.ps1xml", "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsConfig.Format.ps1xml", "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsClientPSProvider.Format.ps1xml"]

exported_functions

list / elements=string

Функции, экспортируемые модулем.

Возвращается: при успехе

Пример: ["New-VirtualDisk", "New-Volume"]

exported_type_files

list / elements=path

Файлы типов, экспортируемые модулем.

Возвращается: при успехе

Пример: ["C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsCmdlets.Types.ps1xml", "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsConfig.Types.ps1xml", "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsClientPSProvider.Types.ps1xml"]

exported_variables

list / elements=string

Переменные, экспортируемые модулем.

Возвращается: при успехе

Пример: ["GitPromptScriptBlock"]

exported_workflows

list / elements=string

Рабочие процессы, экспортируемые модулем.

Возвращается: при успехе

file_list

list / elements=path

Файлы, включённые в модуль.

Возвращается: при успехе

Пример: ["C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSModule.psm1", "C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSGet.Format.ps1xml", "C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSGet.Resource.psd1"]

guid

string

GUID модуля.

Возвращается: при успехе

Пример: "74c9fd30-734b-4c89-a8ae-7727ad21d1d5"

help_info_uri

string

Адрес справочной информации о модуле.

Возвращается: при успехе

Пример: "https://go.microsoft.com/fwlink/?linkid=390823"

icon_uri

string

Адрес значка модуля.

Возвращается: при успехе

Пример: "https://raw.githubusercontent.com/powershell/psscriptanalyzer/master/logo.png"

installed_date

string

Дата установки модуля.

Возвращается: при успехе

Пример: "2018-02-14T17:55:34.9620740-05:00"

installed_location

string

Путь, по которому установлен модуль.

Это значение должно совпадать со значением module_base, но оно указывается только в том случае, если модуль был установлен с помощью PowerShellGet.

Возвращается: при успехе

Пример: "C:\\Program Files\\WindowsPowerShell\\Modules\\posh-git\\0.7.1"

license_uri

string

Адрес лицензии модуля.

Возвращается: при успехе

Пример: "https://github.com/PowerShell/xPendingReboot/blob/master/LICENSE"

log_pipeline_execution_details

boolean

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

Возвращается: при успехе

module_base

string

Путь к каталогу, содержащему файлы модуля.

Возвращается: при успехе

Пример: "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\PKI"

module_list

list / elements=dictionary

Список модулей, входящих в состав этого модуля.

Это значение возвращается нечасто, а содержащиеся в списке модули не обрабатываются автоматически.

Возвращается: при успехе

guid

string

GUID модуля.

Возвращается: при успехе

Пример: "82fdb72c-ecc5-4dfd-b9d5-83cf6eb9067f"

maximum_version

string

Максимальная версия модуля.

Возвращается: при успехе

Пример: "2.9"

name

string

Имя модуля.

Вместо имени здесь также может указываться путь к файлу модуля.

Возвращается: при успехе

Пример: ".\\WindowsUpdateLog.psm1"

required_version

string

Точная требуемая версия модуля.

Возвращается: при успехе

Пример: "3.1.4"

version

string

Минимальная версия модуля.

Возвращается: при успехе

Пример: "2.0"

module_type

string

Тип модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.moduletype

Возвращается: при успехе

Пример: "Script"

name

string

Имя модуля.

Возвращается: при успехе

Пример: "PSReadLine"

nested_modules

list / elements=dictionary

Список модулей, вложенных в этот модуль и загруженных в его область видимости.

Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая nested_modules.

Возвращается: при успехе

package_management_provider

string

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

Возвращается: при успехе

Пример: "NuGet"

path

string

Путь к модулю.

Возвращается: при успехе

Пример: "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\PKI\\PKI.psd1"

power_shell_host_name

string

Имя узла PowerShell, необходимого модулю.

Возвращается: при успехе

Пример: "Windows PowerShell ISE Host"

power_shell_host_version

string

Версия узла PowerShell, необходимая модулю.

Возвращается: при успехе

Пример: "1.1"

power_shell_version

string

Минимальная версия PowerShell, необходимая модулю.

Возвращается: при успехе

Пример: "5.1"

prefix

string

Префикс по умолчанию, добавляемый к командам Verb-Noun, экспортируемым модулем, в результате чего образуются имена Verb-PrefixNoun.

Возвращается: при успехе

private_data

dictionary

Произвольные закрытые данные, используемые модулем. Обычно они определяются в манифесте модуля.

Этот модуль ограничивает глубину возвращаемых данных для типов модулей, отличных от Script и Manifest.

Обычно предоставляется PSData, содержащий метаданные для PowerShellGet, однако эти поля также представлены в свойствах верхнего уровня.

Возвращается: при успехе

Пример: {"PSData": {"LicenseUri": "https://example.com/module/LICENSE", "ProjectUri": "https://example.com/module/", "ReleaseNotes": "v2 - Fixed some bugs\nv1 - First release\n", "Tags": ["networking", "serialization"]}}

procoessor_architecture

string

Архитектура процессора модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.reflection.processorarchitecture

Возвращается: при успехе

Пример: "Amd64"

project_uri

string

Адрес проекта модуля.

Возвращается: при успехе

Пример: "https://github.com/psake/psake"

published_date

string

Дата публикации модуля.

Возвращается: при успехе

Пример: "2017-03-15T04:18:09.0000000"

release_notes

string

Примечания к выпуску модуля. Это поле со свободным текстом, поэтому не следует предполагать наличие какого-либо определенного формата.

Возвращается: при успехе

Пример: "## 1.4.6\n- Update `HelpInfoUri` to point to the latest content\n\n## 1.4.5\n- Bug fix for deadlock when getting parameters in an event\n\n## 1.4.4\n- Bug fix when installing modules from private feeds\n"

repository

string

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

Это значение не является историческим. Оно зависит от PSRepository, зарегистрированных сейчас для текущего пользователя.

Значение repository_source_location должно соответствовать текущему расположению источника зарегистрированного репозитория, чтобы получить имя репозитория.

Если совпадение не найдено, это значение будет соответствовать repository_source_location.

Возвращается: при успехе

Пример: "PSGallery"

repository_source_location

string

Расположение источника репозитория, из которого был установлен модуль.

Возвращается: при успехе

Пример: "https://www.powershellgallery.com/api/v2"

required_assemblies

string

Список сборок, необходимых модулю.

Значения могут быть простыми именами или полными путями.

Возвращается: при успехе

Пример: "['Microsoft.Management.Infrastructure.CimCmdlets.dll', 'Microsoft.Management.Infrastructure.Dll']"

required_modules

list / elements=dictionary

Список модулей, необходимых этому модулю.

Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая required_modules.

Однако эти объекты модулей могут не содержать полную информацию, поэтому результаты могут отличаться от тех, которые вы получили бы при непосредственном запросе модуля.

Возвращается: при успехе

root_module

string

Корневой модуль, указанный в манифесте.

Это может быть имя модуля, имя файла или полный путь.

Возвращается: при успехе

Пример: "WindowsErrorReporting.psm1"

scripts

list / elements=string

Список скриптов (файлов .ps1), выполняемых в состоянии сеанса вызывающего объекта при импорте модуля.

Это значение берется из поля ScriptsToProcess манифеста модуля.

Возвращается: при успехе

Пример: ["PrepareEnvironment.ps1", "InitializeData.ps1"]

tags

list / elements=string

Теги, указанные в метаданных PSData модуля.

Возвращается: при успехе

Пример: ["networking", "serialization", "git", "dsc"]

updated_date

string

Дата последнего обновления модуля.

Возвращается: при успехе

Пример: "2019-12-31T09:20:02.0000000"

version

string

Версия модуля.

Возвращается: при успехе

Пример: "1.2.3"