Создание манифеста модуля PowerShell

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

Создание манифеста модуля

Манифест модуля — это файл данных PowerShell,.psd1 описывающий содержимое модуля и определяющий способ обработки модуля. Файл манифеста — это текстовый файл, содержащий хэш-таблицу ключей и значений. Файл манифеста связывается с модулем, именуя манифест так же, как модуль, и сохраняя манифест в корневом каталоге модуля.

Для простых модулей, содержащих только одну .psm1 или двоичную сборку, манифест модуля необязателен. Но рекомендация заключается в том, чтобы использовать манифест модуля по возможности, так как они полезны для организации кода и поддержания сведений о версиях. Кроме того, для экспорта сборки, установленной в глобальном кэше сборок, требуется манифест модуля. Манифест модуля также необходим для модулей, поддерживающих функцию обновляемой справки. Обновляемая справка использует ключ HelpInfoUri в манифесте модуля для поиска файла справки (HelpInfo XML), содержащего расположение обновленных файлов справки для модуля. Дополнительные сведения о обновляемой справке см. в статье "Поддержка обновляемой справки".

Создание и использование манифеста модуля

Рекомендуется создать манифест модуля, чтобы использовать командлет New-ModuleManifest . Параметры можно использовать для указания одного или нескольких ключей и значений манифеста по умолчанию. Единственным требованием является имя файла. New-ModuleManifest создает манифест модуля с указанными значениями и включает оставшиеся ключи и их значения по умолчанию. Если вам нужно создать несколько модулей, используйте New-ModuleManifest для создания шаблона манифеста модуля, который можно изменить для различных модулей. Пример манифеста модуля по умолчанию см. в примере манифеста модуля.

New-ModuleManifest -Path C:\myModuleName.psd1 -ModuleVersion "2.0" -Author "YourNameHere"

Альтернативой является создание хэш-таблицы манифеста модуля вручную с помощью минимальной информации, необходимой для ModuleVersion. Сохраните файл с тем же именем, что и модуль, и используйте .psd1 расширение файла. Затем можно изменить файл и добавить соответствующие ключи и значения.
Добавьте дополнительные элементы, которые требуется в файле манифеста.

Чтобы изменить файл манифеста, используйте любой текстовый редактор, который вы предпочитаете. Но файл манифеста — это файл скрипта, содержащий код, поэтому вы можете изменить его в среде сценариев или среды разработки, например Visual Studio Code. Все элементы файла манифеста являются необязательными, за исключением номера ModuleVersion .

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

Для проблем с безопасностью PowerShell выполняет только небольшое подмножество доступных операций в файле манифеста модуля. Как правило, можно использовать if операторы, арифметические операторы и операторы сравнения, а также базовые типы данных PowerShell.
После создания манифеста модуля его можно проверить, чтобы убедиться, что все пути, описанные в манифесте, верны. Чтобы протестировать манифест модуля, используйте Test-ModuleManifest.

Test-ModuleManifest myModuleName.psd1
Убедитесь, что манифест модуля находится на верхнем уровне каталога, содержащего модуль.

При копировании модуля в систему и его импорте PowerShell использует манифест модуля для импорта модуля.
При необходимости можно напрямую протестировать манифест модуля с вызовом Import-Module , определив сам манифест.

Import-Module .\myModuleName.psd1

Пример манифеста модуля

Следующий пример манифеста модуля был создан в New-ModuleManifest PowerShell 7 и содержит ключи и значения по умолчанию. Подробное описание каждого элемента в манифесте модуля см. в about_Module_Manifests.

#
# Module manifest for module 'SampleModuleManifest'
#
# Generated by: User01
#
# Generated on: 10/15/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'b632e90c-df3d-4340-9f6c-3b832646bf87'

# Author of this module
Author = 'User01'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) User01. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

См. также

Обратная связь

Были ли сведения на этой странице полезными?

Last updated on 2026-05-04

Создание манифеста модуля PowerShell