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
Задает экспортируемые модулем псевдонимы. Разрешено использовать подстановочные знаки.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Author
Задает автора модуля.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClrVersion
Указывает минимальную версию СРЕДЫ CLR microsoft платформа .NET Framework, необходимую модулю.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CmdletsToExport
Задает экспортируемые модулем командлеты. Разрешено использовать подстановочные знаки.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-CompanyName
Указывает компанию или поставщика, создавшего модуль.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompatiblePSEditions
Указывает совместимые psEditions модуля. Сведения о PSEdition см. в статье Модули с совместимыми выпусками PowerShell.
| Type: | String[] |
| Accepted values: | Desktop, Core |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Copyright
Задает заявление об авторских правах на модуль.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultCommandPrefix
Указывает префикс команды по умолчанию.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Указывает описание модуля.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DotNetFrameworkVersion
Указывает минимальную версию платформа .NET Framework Майкрософт, необходимую модулю.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DscResourcesToExport
Указывает ресурсы Desired State Configuration (DSC), экспортируемые модулем. Разрешено использовать подстановочные знаки.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ExternalModuleDependencies
Задает массив зависимостей внешних модулей.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileList
Задает все элементы, включенные в модуль.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FormatsToProcess
Указывает файлы форматирования (.ps1xml), которые обрабатываются при импорте модуля.
При импорте модуля PowerShell запускает Update-FormatData командлет с указанными файлами.
Так как файлы форматирования не являются областью действия, они влияют на все состояния сеанса в сеансе.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FunctionsToExport
Задает экспортируемые модулем функции. Разрешено использовать подстановочные знаки.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Guid
Задает уникальный идентификатор модуля. Guid используется для различения модулей с одинаковым именем.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpInfoUri
Указывает интернет-адрес XML-файла HelpInfo модуля. Введите универсальный код ресурса (URI), который начинается с http: или https:.
Дополнительные сведения см. в разделе Обновляемая справка.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUri
Указывает универсальный код ресурса (URI) значка для модуля. Указанный значок отображается на веб-странице коллекции модуля.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseUri
Указывает URL-адрес условий лицензирования для модуля.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleList
Задает массив модулей, включенных в модуль.
Введите имя каждого модуля в виде строки или хэш-строки с помощью ключей ModuleName и ModuleVersion . Хэш-сводка также может иметь необязательный ключ GUID . В значении параметра можно объединить строки и хэш-данные.
Этот ключ выполняет функцию полного списка ресурсов модуля.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleVersion
Указывает версию модуля.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NestedModules
Указывает модули скриптов (.psm1) и двоичные модули (.dll), которые импортируются в состояние сеанса модуля. Файлы в ключе NestedModules выполняются в том порядке, в котором они перечислены.
Введите имя каждого модуля в виде строки или хэш-строки с помощью ключей ModuleName и ModuleVersion . Хэш-сводка также может иметь необязательный ключ GUID . В значении параметра можно объединить строки и хэш-данные.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Указывает путь и имя файла манифеста модуля. Введите имя файла с расширением .psd1 файла.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellHostName
Указывает имя ведущего приложения PowerShell, которое требуется модулю. Введите имя ведущего приложения, например Узел интегрированной среды сценариев PowerShell или ConsoleHost. Подстановочные знаки запрещены.
Имя ведущей программы хранится в $Host.Name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellHostVersion
Указывает минимальную версию ведущего приложения PowerShell, которая работает с модулем. Введите номер версии, например, 1.1.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellVersion
Указывает минимальную версию PowerShell, которая работает с этим модулем. Например, можно указать версии, такие как 5.1 или 7.2.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Prerelease
Указывает значение предварительной версии, добавляемое к версии модуля. Например, если prerelease имеет значение preview , а ModuleVersion — 1.0.0, версия модуля — 1.0.0-preview.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateData
Указывает данные, передаваемые модулю при его импорте. Это могут быть любые произвольные значения, хранящиеся в хэш-таблицы.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProcessorArchitecture
Указывает архитектуру процессора, необходимую для этого модуля.
Допустимые значения для этого параметра:
Amd64ArmIA64MSILNone(неизвестно или не указано)X86
| Type: | ProcessorArchitecture |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectUri
Указывает универсальный код ресурса (URI) веб-страницы этого проекта.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleaseNotes
Указывает строку, содержащую заметки о выпуске или комментарии для модуля.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredAssemblies
Указывает файлы сборки (.dll), необходимые модулю. PowerShell загружает указанные сборки перед обновлением типов или форматов, импортом вложенных модулей или импортом файла модуля, указанного в ключе RootModule .
Используйте RequiredAssemblies для сборок, которые должны быть загружены для обновления файлов форматирования или типов, перечисленных в ключах FormatToProcess или TypesToProcess , даже если эти сборки также указаны в разделе NestedModules .
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredModules
Определяет модули, которые должны присутствовать в глобальном состоянии сеанса. Если необходимые модули не в состоянии глобального сеанса, PowerShell импортирует их. Если необходимые модули недоступны, команда завершается ошибкой Import-Module .
Значением может быть массив, содержащий имена модулей или спецификации модуля. Спецификация модуля — это хэш-таблице со следующими ключами.
ModuleName- Обязательно Указывает имя модуля.GUID- Дополнительные Указывает GUID модуля.- Кроме того, необходимо указать по крайней мере один из трех приведенных ниже ключей.
ModuleVersion— задает минимальную допустимую версию модуля.MaximumVersion— задает максимально допустимую версию модуля.RequiredVersion— указывает точную требуемую версию модуля. Его нельзя использовать с другими ключами версии.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireLicenseAcceptance
Указывает, что для модуля требуется принятие лицензии.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RootModule
Указывает основной или корневой файл модуля. Введите имя файла скрипта (.ps1), модуля скрипта (.psm1), манифеста модуля (.psd1), сборки (.dll) или XML-файла определения командлета (.cdxml). При импорте модуля элементы, экспортированные из корневого модуля, импортируются в состояние сеанса вызывающей стороны.
Если модуль содержит файл манифеста и в ключе RootModule не указан файл, манифест становится основным файлом модуля. Модуль называется модулем манифеста (ModuleType =
Manifest).
Чтобы экспортировать элементы из .psm1 файлов или .dll , имена этих файлов должны быть указаны в значениях ключей RootModule или NestedModules в манифесте.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScriptsToProcess
Указывает файлы скриптов (.ps1), которые выполняются в состоянии сеанса вызывающего объекта при импорте модуля.
Эти скрипты можно использовать для подготовки среды таким же образом, как и скрипт входа в систему.
Чтобы указать скрипты, которые будут выполняться в состоянии сеанса модуля, используйте ключ NestedModules.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
Указывает массив тегов.
| Type: | String[] |
| Aliases: | Tag |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TypesToProcess
Указывает файлы типа (.ps1xml), которые запускаются при импорте модуля.
При импорте модуля PowerShell запускает Update-TypeData командлет с указанными файлами.
Так как файлы типов не ограничены областью действия, они влияют на все состояния сеанса в сеансе.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VariablesToExport
Задает экспортируемые модулем переменные. Разрешено использовать подстановочные знаки.
Используйте этот параметр, чтобы ограничить, какие переменные экспортируются модулем.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
Входные данные
None
Выходные данные
Примечания
Полное описание файла манифеста модуля см. в разделе about_Module_Manifests.
Связанные ссылки
PSResourceGet
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по