Update-PSModuleManifest
Обновляет файл манифеста модуля.
Синтаксис
Update-PSModuleManifest
[-Path] <String>
[-NestedModules <Object[]>]
[-Guid <Guid>]
[-Author <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RootModule <String>]
[-ModuleVersion <Version>]
[-Description <String>]
[-ProcessorArchitecture <ProcessorArchitecture>]
[-CompatiblePSEditions <String[]>]
[-PowerShellVersion <Version>]
[-ClrVersion <Version>]
[-DotNetFrameworkVersion <Version>]
[-PowerShellHostName <String>]
[-PowerShellHostVersion <Version>]
[-RequiredModules <Object[]>]
[-TypesToProcess <String[]>]
[-FormatsToProcess <String[]>]
[-ScriptsToProcess <String[]>]
[-RequiredAssemblies <String[]>]
[-FileList <String[]>]
[-ModuleList <Object[]>]
[-FunctionsToExport <String[]>]
[-AliasesToExport <String[]>]
[-VariablesToExport <String[]>]
[-CmdletsToExport <String[]>]
[-DscResourcesToExport <String[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String>]
[-Prerelease <String>]
[-HelpInfoUri <Uri>]
[-DefaultCommandPrefix <String>]
[-ExternalModuleDependencies <String[]>]
[-RequireLicenseAcceptance]
[-PrivateData <Hashtable>]
[<CommonParameters>]
Описание
Этот командлет обновляет данные, хранящиеся в файле манифеста модуля. Параметры позволяют указать, какие свойства обновляются.
Update-PSModuleManifest
перезаписывает все существующие значения в манифесте модуля.
Командлет не возвращает объект.
Примеры
Пример 1
В этом примере свойство Author в манифесте New Author
модуля изменяется на .
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'
Пример 2
В этом примере свойство Prerelease изменяется на beta2
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'
Пример 3
В этом примере обновляется несколько свойств.
$parameters = @{
Path = 'C:\MyModules\TestModule'
Tags = 'Windows', 'Linux'
Description = 'A module for managing packages.'
}
Update-PSModuleManifest
Параметры
-AliasesToExport
Указывает псевдонимы, экспортируемые модулем. Подстановочные символы разрешены.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-Author
Указывает автора модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ClrVersion
Указывает минимальную версию среды CLR для Платформы Microsoft .NET Framework, требуемой модулем.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-CmdletsToExport
Указывает командлеты, экспортируемые модулем. Подстановочные символы разрешены.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-CompanyName
Указывает компанию или поставщика, создавшего модуль.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-CompatiblePSEditions
Указывает совместимые PSEditions модуля. Сведения о PSEdition см. в модулях с совместимыми выпусками PowerShell.
Тип: | String[] |
Допустимые значения: | Desktop, Core |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Copyright
Указывает заявление об авторских правах для модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultCommandPrefix
Задает префикс команды по умолчанию.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Description
Указывает описание модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DotNetFrameworkVersion
Указывает минимальную версию Microsoft .NET Framework, необходимую модулю.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DscResourcesToExport
Указывает ресурсы требуемой конфигурации состояния (DSC), экспортируемые модулем. Подстановочные символы разрешены.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-ExternalModuleDependencies
Задает массив зависимостей внешнего модуля.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-FileList
Указывает все элементы, включенные в модуль.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-FormatsToProcess
Указывает файлы форматирования (.ps1xml
), обрабатываемые при импорте модуля.
При импорте модуля PowerShell запускает командлет Update-FormatData
с указанными файлами.
Поскольку файлы форматирования не ограничены, они влияют на все состояния в сеансе.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-FunctionsToExport
Указывает функции, экспортируемые модулем. Подстановочные символы разрешены.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-Guid
Указывает уникальный идентификатор модуля. GUID используется для различения модулей с одинаковым именем.
Тип: | Guid |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-HelpInfoUri
Указывает интернет-адрес XML-файла HelpInfo модуля. Введите универсальный идентификатор ресурса (URI), начинающийся с http:
или https:
.
Дополнительные сведения см. в справке по обновляемой версии.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-IconUri
Задает универсальный код ресурса (URI) значка для модуля. Указанный значок отображается на веб-странице галереи для модуля.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-LicenseUri
Указывает URL-адрес условий лицензирования модуля.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ModuleList
Задает массив модулей, включенных в модуль.
Введите имя каждого модуля в виде строки или хэш-файла с ключами ModuleName и ModuleVersion . Хэш-файл также может иметь необязательный ключ GUID . Строки и хэштеблы можно объединить в значение параметра.
Этот ключ предназначен для работы в качестве инвентаризации модулей.
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ModuleVersion
Указывает версию модуля.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-NestedModules
Задает модули скриптов (.psm1
) и двоичные модули (.dll
), импортируемые в состояние сеанса модуля. Файлы в ключе NestedModules выполняются в том порядке, в котором они перечислены.
Введите имя каждого модуля в виде строки или хэш-файла с ключами ModuleName и ModuleVersion . Хэш-файл также может иметь необязательный ключ GUID . Строки и хэштеблы можно объединить в значение параметра.
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Path
Указывает путь и имя файла манифеста модуля. Введите имя файла с расширением .psd1
файла.
Тип: | String |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellHostName
Указывает имя конечной программы PowerShell, которую требует модуль. Введите имя хост-программы, например узел интегрированной среды сценариев PowerShell или ConsoleHost. Подстановочные знаки не разрешены.
Имя хост-программы хранится в $Host.Name
.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellHostVersion
Указывает минимальную версию хост-программы PowerShell, которая работает с модулем. Введите номер версии, например 1.1.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellVersion
Указывает минимальную версию PowerShell, которая работает с этим модулем. Например, можно указать такие версии, как 5.1
или 7.2
.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Prerelease
Указывает предварительное значение, которое добавляется в версию модуля. Например, если предварительная версия и moduleVersion имеет 1.0.0
preview
значение , версия модуля — 1.0.0-preview
это .
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PrivateData
Указывает данные, передаваемые модулю при импорте. Это могут быть любые произвольные значения, хранящиеся в хэш-таблицы.
Тип: | Hashtable |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ProcessorArchitecture
Указывает архитектуру процессора, требуемую модулем.
Допустимые значения для этого параметра:
Amd64
Arm
IA64
MSIL
-
None
(неизвестно или не указано) X86
Тип: | ProcessorArchitecture |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ProjectUri
Задает универсальный код ресурса (URI) веб-страницы для этого проекта.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ReleaseNotes
Указывает строку, содержащую заметки о выпуске или комментарии для модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RequiredAssemblies
Указывает файлы сборки (.dll
), необходимые модулю. PowerShell загружает указанные сборки перед обновлением типов или форматов, импортом вложенных модулей или импортом файла модуля, указанного в ключе RootModule .
Используйте requiredAssemblies для сборок, которые должны быть загружены для обновления всех файлов форматирования или типов, перечисленных в ключах FormatToProcess или TypesToProcess , даже если эти сборки также перечислены в ключе NestedModules .
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RequiredModules
Указывает модули, которые должны находиться в состоянии глобального сеанса. Если необходимых модулей нет в состоянии глобального сеанса, PowerShell импортирует их. Если необходимые модули недоступны, команда Import-Module
завершается ошибкой.
Это значение может быть массивом, содержащим имена модулей или спецификации модулей. Спецификация модуля — это хэш-файл, имеющий следующие ключи.
-
ModuleName
- Обязательный Указывает имя модуля. -
GUID
- Необязательный указывает GUID модуля. - Это также Обязательный, чтобы указать хотя бы один из трех приведенных ниже ключей.
-
ModuleVersion
. Указывает минимальную допустимую версию модуля. -
MaximumVersion
. Указывает максимальную допустимую версию модуля. -
RequiredVersion
. Указывает точную, требуемую версию модуля. Это невозможно использовать с другими ключами версии.
-
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RequireLicenseAcceptance
Указывает, что для модуля требуется принятие лицензии.
Тип: | SwitchParameter |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RootModule
Указывает основной или корневой файл модуля. Введите имя файла скрипта (), модуль скрипта (.ps1
), манифест модуля модуля (), сборку (.psd1
.dll
) или XML-файл определения командлета (.cdxml
)..psm1
При импорте модуля члены, экспортированные из корневого модуля, импортируются в состояние сеанса вызывающего объекта.
Если модуль содержит файл манифеста и файл не указан в ключе RootModule , манифест становится основным файлом для модуля. Модуль называется модулем манифеста (ModuleType =
Manifest
).
Чтобы экспортировать элементы из .psm1
.dll
или файлов, имена этих файлов необходимо указать в значениях ключей RootModule или NestedModules в манифесте.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ScriptsToProcess
Задает файлы скрипта (.ps1
), которые выполняются в состоянии сеанса вызывающего объекта при импорте модуля.
Эти сценарии можно использовать для подготовки среды так же, как и скрипт входа.
Чтобы указать скрипты, которые выполняются в состоянии сеанса модуля, используйте ключ NestedModules.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Tags
Задает массив тегов.
Тип: | String[] |
Aliases: | Tag |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-TypesToProcess
Указывает файлы типов (.ps1xml
), которые выполняются при импорте модуля.
При импорте модуля PowerShell запускает командлет Update-TypeData
с указанными файлами.
Поскольку файлы типов не имеют области видимости, они влияют на все состояния сеанса.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-VariablesToExport
Указывает переменные, экспортируемые модулем. Подстановочные символы разрешены.
Используйте этот параметр, чтобы ограничить, какие переменные экспортируются модулем.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
Входные данные
None
Выходные данные
Примечания
Полное описание файла манифеста модуля см. в about_Module_Manifests.
Связанные ссылки
PSResourceGet