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

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. Обновление манифеста модуля

В этом примере обновляется существующий файл манифеста модуля. Сплаттинг используется для передачи значений параметров в 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 — это splat, в котором хранятся значения параметров Path, Author, CompanyName и Copyright. Update-ModuleManifest получает значения параметров из @Params и обновляет манифест модуля TestManifest.psd1.

Параметры

-AliasesToExport

Задает экспортируемые модулем псевдонимы. Разрешено использовать подстановочные знаки.

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

Примечание

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

Type:Version
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CmdletsToExport

Задает экспортируемые модулем командлеты. Разрешено использовать подстановочные знаки.

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

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

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

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

Примечание

Этот параметр действителен только для выпуска PowerShell Desktop, например Windows PowerShell 5.1, и применяется только к платформа .NET Framework версиям ниже 4.5. Это требование не влияет на более новые версии PowerShell или платформа .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:False

-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

Задает экспортируемые модулем функции. Разрешено использовать подстановочные знаки.

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

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

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

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconUri

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

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

-PackageManagementProviders

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

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

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

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

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

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

Type:Version
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Prerelease

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

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

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

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

  • Amd64
  • Arm
  • IA64
  • MSIL
  • Нет (неизвестно или не указано)
  • X86
Type:ProcessorArchitecture
Accepted values:None, MSIL, X86, IA64, Amd64, Arm
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProjectUri

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

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 .

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredModules

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

Type:Object[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequireLicenseAcceptance

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RootModule

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

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

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

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

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[]
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

Задает экспортируемые модулем переменные. Разрешено использовать подстановочные знаки.

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

String

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

Object