Update-PSModuleManifest

Модуль:

Microsoft.PowerShell.PSResourceGet

Обновляет файл манифеста модуля.

Синтаксис

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

Указывает минимальную версию платформа .NET Framework Майкрософт, необходимую модулю.

Тип:	Version
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-DscResourcesToExport

Указывает ресурсы Desired State Configuration (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

Указывает значение предварительной версии, добавляемое к версии модуля. Например, если prerelease имеет значение preview , а ModuleVersion — 1.0.0, версия модуля — 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), модуля скрипта (.psm1), манифеста модуля (.psd1), сборки (.dll) или XML-файла определения командлета (.cdxml). При импорте модуля элементы, экспортированные из корневого модуля, импортируются в состояние сеанса вызывающей стороны.

Если модуль содержит файл манифеста и в ключе 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

Выходные данные

Object

Примечания

Полное описание файла манифеста модуля см. в разделе about_Module_Manifests.

Связанные ссылки

• New-ModuleManifest