Update-ModuleManifest

Ссылка

Модуль:: PowerShellGet

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

Синтаксис

Update-ModuleManifest
      [-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[]>]
      [-PrivateData <Hashtable>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-PassThru]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-PackageManagementProviders <String[]>]
      [-RequireLicenseAcceptance]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Командлет Update-ModuleManifest обновляет файл манифеста модуля (.psd1).

Это командлет прокси-сервера для командлета Update-PSModuleManifest в Microsoft.PowerShell.PSResourceGet. Дополнительные сведения см. в разделе Update-PSModuleManifest.

Примеры

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

В этом примере обновляется существующий файл манифеста модуля. Splatting используется для передачи значений Update-ModuleManifestпараметров в . Дополнительные сведения см. в about_Splatting.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params — это знак, в который хранятся значения параметров для Path, Author, CompanyName и Copyright. Update-ModuleManifest получает значения параметров из @Params манифеста модуля TestManifest.psd1.

Параметры

-AliasesToExport

Указывает псевдонимы, экспортируемые модулем. Подстановочные символы разрешены.

Используйте этот параметр, чтобы ограничить псевдонимы, экспортированные модулем. 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, требуемую модулем.

Замечание

Этот параметр действителен только для выпуска PowerShell Desktop, например Windows PowerShell 5.1, и применяется только к версиям .NET Framework ниже 4.5. Это требование не влияет на более новые версии PowerShell или .NET Framework.

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

-CmdletsToExport

Указывает командлеты, экспортируемые модулем. Подстановочные символы разрешены.

Используйте этот параметр, чтобы ограничить командлеты, экспортированные модулем. КомандлетыToExport могут удалять командлеты из списка экспортированных командлетов, но не могут добавлять командлеты в список.

Тип:	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

-Confirm

Запрашивает подтверждение перед запуском Update-ModuleManifest.

Тип:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Обязательно:	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
Принять подстановочные знаки:	False

-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

Указывает функции, экспортируемые модулем. Подстановочные символы разрешены.

Используйте этот параметр, чтобы ограничить функции, экспортированные модулем. 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.

XML-файл HelpInfo поддерживает обновляемую функцию справки, которая появилась в PowerShell версии 3.0. Он содержит сведения о расположении загружаемых файлов справки модуля и номерах версий новейших файлов справки для каждого поддерживаемого языкового стандарта.

Сведения об обновляемой справке смотрите в about_Updatable_Help. Сведения о XML-файле HelpInfo см. в статье "Поддержка обновляемой справки".

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

-IconUri

Указывает URL-адрес значка модуля. Указанный значок отображается на веб-странице галереи для модуля.

Тип:	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 запускаются в том порядке, в котором они указаны в этом значении.

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

-PackageManagementProviders

Задает массив поставщиков управления пакетами.

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

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию Update-ModuleManifest не создает выходные данные.

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

-Path

Указывает путь и имя файла манифеста модуля. Введите путь и имя файла с расширением имени файла .psd1, например $PSHOME\Modules\MyModule\MyModule.psd1.

Если указать путь к существующему файлу, Update-ModuleManifest заменяет файл без предупреждения, если файл не имеет атрибута только для чтения.

Манифест должен находиться в каталоге модуля, а имя файла манифеста должно совпадать с именем каталога модуля, но с расширением .psd1 .

Нельзя использовать переменные, например $PSHOME или $HOME, в ответ на запрос значения параметра Path . Чтобы использовать переменную, включите параметр пути в команду.

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	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, которая будет работать с этим модулем. Например, можно указать 3.0, 4.0 или 5.0 в качестве значения этого параметра.

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

-Prerelease

Указывает, что модуль предварительно настроен.

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

-PrivateData

Указывает данные, передаваемые модулю при его импорте.

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

-ProcessorArchitecture

Указывает архитектуру процессора, требуемую модулем.

Допустимые значения для этого параметра:

Amd64
Рука
IA64
MSIL
Нет (неизвестно или не указано)
X86

Тип:	ProcessorArchitecture
Допустимые значения:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ProjectUri

Указывает URL-адрес веб-страницы этого проекта.

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

-ReleaseNotes

Задает строковый массив, содержащий заметки о выпуске или комментарии, доступные для этой версии скрипта.

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

-RequiredAssemblies

Указывает файлы сборки (.dll), необходимые модулю. Введите имена файлов сборки. PowerShell загружает указанные сборки перед обновлением типов или форматов, импортом вложенных модулей или импортом файла модуля, указанного в значении ключа RootModule.

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

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

-RequiredModules

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

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

-RequireLicenseAcceptance

Указывает, что для модуля требуется принятие лицензии.

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

-RootModule

Указывает основной или корневой файл модуля. Введите имя файла скрипта (), модуль скрипта (.ps1), манифест модуля модуля (), сборку (.dll.psd1), XML-файл.cdxml определения командлета или рабочий процесс (.xaml)..psm1 При импорте модуля члены, экспортированные из корневого файла модуля, импортируются в состояние сеанса вызывающего объекта.

Если модуль содержит файл манифеста и корневой файл не указан в ключе RootModule , манифест становится основным файлом для модуля. И модуль становится модулем манифеста (ModuleType = Manifest).

Чтобы экспортировать элементы из файлов .psm1 или .dll в модуле с манифестом, необходимо указать имена этих файлов в значениях ключей RootModule или NestedModules в манифесте. В противном случае их члены не экспортируются.

В PowerShell 2.0 этот ключ назывался ModuleToProcess.

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

-ScriptsToProcess

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

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

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

-Tags

Задает массив тегов.

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

-TypesToProcess

Указывает файлы типов (.ps1xml), которые выполняются при импорте модуля.

При импорте модуля PowerShell запускает командлет Update-TypeData с указанными файлами. Поскольку файлы типов не имеют области видимости, они влияют на все состояния сеанса.

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

-VariablesToExport

Указывает переменные, экспортируемые модулем. Подстановочные символы разрешены.

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

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

-WhatIf

Показывает, что произойдет, если Update-ModuleManifest будет запущен. Командлет не выполняется.

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

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

String

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

Object

Поделиться через