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

说明

此 cmdlet 更新存储在模块清单文件中的数据。 参数允许指定更新的属性。 Update-PSModuleManifest 覆盖模块清单中的任何现有值。

该 cmdlet 不返回对象。

示例

示例 1

本示例将模块清单中的 Author 属性更改为 New Author。

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'

示例 2

本示例将 预发行版 属性更改为 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
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-Author

指定模块作者。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ClrVersion

指定模块所需的 Microsoft .NET Framework 公共语言运行时 （CLR）的最低版本。

类型:	Version
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CmdletsToExport

指定模块导出的 cmdlet。 允许通配符。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-CompanyName

指定创建模块的公司或供应商。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CompatiblePSEditions

指定模块的兼容 PSEditions。 有关 PSEdition的信息，请参阅 模块与兼容的 PowerShell Editions。

类型:	String[]
接受的值:	Desktop, Core
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Copyright

指定模块的版权声明。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DefaultCommandPrefix

指定默认命令前缀。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Description

指定模块的说明。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DotNetFrameworkVersion

指定模块所需的Microsoft .NET Framework 的最低版本。

类型:	Version
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DscResourcesToExport

指定模块导出的 Desired State Configuration （DSC） 资源。 允许通配符。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-ExternalModuleDependencies

指定外部模块依赖项的数组。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FileList

指定模块中包含的所有项。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FormatsToProcess

指定导入模块时处理的格式设置文件（.ps1xml）。

导入模块时，PowerShell 使用指定的文件运行 Update-FormatData cmdlet。 由于格式设置文件的范围不一定，因此它们会影响会话中的所有会话状态。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FunctionsToExport

指定模块导出的函数。 允许通配符。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

-Guid

指定模块的唯一标识符。 GUID 用于区分具有相同名称的模块。

类型:	Guid
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-HelpInfoUri

指定模块的 HelpInfo XML 文件的 Internet 地址。 输入以 http: 或 https:开头的统一资源标识符（URI）。

有关详细信息，请参阅 可更新的帮助。

类型:	Uri
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IconUri

指定模块图标的 URI。 指定的图标显示在模块的库网页上。

类型:	Uri
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-LicenseUri

指定模块许可条款的 URL。

类型:	Uri
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ModuleList

指定模块中包含的模块数组。

输入每个模块名称作为字符串或包含 ModuleName 和 ModuleVersion 键的哈希表。 哈希表还可以具有可选的 GUID 键。 可以在参数值中合并字符串和哈希表。

此密钥旨在充当模块清单。

类型:	Object[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ModuleVersion

指定模块的版本。

类型:	Version
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-NestedModules

指定导入模块会话状态的脚本模块（.psm1）和二进制模块（.dll）。 NestedModules 中的文件 键按列出的顺序运行。

输入每个模块名称作为字符串或包含 ModuleName 和 ModuleVersion 键的哈希表。 哈希表还可以具有可选的 GUID 键。 可以在参数值中合并字符串和哈希表。

类型:	Object[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Path

指定模块清单的路径和文件名。 输入文件扩展名为 .psd1 的文件名。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-PowerShellHostName

指定模块所需的 PowerShell 主机程序的名称。 输入主机程序的名称，例如 PowerShell ISE 主机或 ConsoleHost。 不允许通配符。

主机程序的名称存储在 $Host.Name中。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PowerShellHostVersion

指定适用于该模块的 PowerShell 主机程序的最低版本。 输入版本号，例如 1.1。

类型:	Version
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PowerShellVersion

指定适用于此模块的 PowerShell 的最低版本。 例如，可以指定 5.1 或 7.2等版本。

类型:	Version
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Prerelease

指定追加到模块版本的预发行版值。 例如，如果 预发行版preview，并且 ModuleVersion1.0.0，则模块的版本 1.0.0-preview。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PrivateData

指定导入模块时传递给模块的数据。 这可以是存储在哈希表中的任何任意值。

类型:	Hashtable
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ProcessorArchitecture

指定模块所需的处理器体系结构。

此参数的可接受值为：

• Amd64
• Arm
• IA64
• MSIL
• None（未知或未指定）
• X86

类型:	ProcessorArchitecture
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ProjectUri

指定有关此项目的网页的 URI。

类型:	Uri
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ReleaseNotes

指定包含模块发行说明或注释的字符串。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RequiredAssemblies

指定模块所需的程序集 （.dll） 文件。 PowerShell 在更新类型或格式、导入嵌套模块或导入 RootModule 键中指定的模块文件之前加载指定的程序集。

对必须加载的程序集使用 RequiredAssemblies，以更新 FormatsToProcess 或 TypesToProcess 键中列出的任何格式或类型文件，即使这些程序集也列在 NestedModules 键中。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RequiredModules

指定必须处于全局会话状态的模块。 如果所需的模块未处于全局会话状态，PowerShell 会导入它们。 如果所需的模块不可用，Import-Module 命令将失败。

该值可以是包含模块名称或模块规范的数组。 模块规范是具有以下键的哈希表。

• ModuleName - 必需 指定模块名称。
• GUID - 可选 指定模块的 GUID。
• 它还 必需 指定以下三个键中的至少一个。
  • ModuleVersion - 指定模块的最低可接受版本。
  • MaximumVersion - 指定模块的最大可接受版本。
  • RequiredVersion - 指定模块的确切所需版本。 这不能与其他版本密钥一起使用。

类型:	Object[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-RequireLicenseAcceptance

指定模块需要接受许可证。

类型:	SwitchParameter
Position:	Named
默认值:	False
必需:	False
接受管道输入:	False
接受通配符:	False

-RootModule

指定模块的主文件或根文件。 输入脚本（.ps1）、脚本模块（.psm1）、模块清单（.psd1）、程序集（.dll）或 cmdlet 定义 XML 文件（.cdxml） 的文件名。 导入模块后，从根模块导出的成员将导入到调用者的会话状态。

如果模块具有清单文件，并且未在 RootModule 键中指定任何文件，则清单将成为该模块的主文件。 该模块称为清单模块（ModuleType = Manifest）。

若要从 .psm1 或 .dll 文件中导出成员，必须在清单中的 RootModule 或 NestedModules 键的值中指定这些文件的名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ScriptsToProcess

指定导入模块时在调用方会话状态中运行的脚本 （.ps1） 文件。 可以使用这些脚本来准备环境，就像使用登录脚本一样。

若要指定在模块的会话状态中运行的脚本，请使用 NestedModules 键。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Tags

指定标记数组。

类型:	String[]
别名:	Tag
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-TypesToProcess

指定导入模块时运行的类型文件（.ps1xml）。

导入模块时，PowerShell 使用指定的文件运行 Update-TypeData cmdlet。 由于类型文件没有限定范围，因此它们会影响会话中的所有会话状态。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-VariablesToExport

指定模块导出的变量。 允许通配符。

使用此参数可限制模块导出的变量。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	True

输入

None

输出

Object

备注

有关模块清单文件的完整说明，请参阅 about_Module_Manifests。

相关链接

• New-ModuleManifest