Update-PSModuleManifest

更新模块清单文件。

语法

Default (默认值)

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

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Author

指定模块作者。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ClrVersion

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

参数属性

类型:Version
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CmdletsToExport

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

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CompanyName

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CompatiblePSEditions

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

参数属性

类型:

String[]

默认值:None
接受的值:Desktop, Core
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

为模块指定版权声明。

类型:String
默认值:None
支持通配符:False
不显示:False
(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultCommandPrefix

指定默认命令前缀。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Description

指定模块的说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DotNetFrameworkVersion

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

参数属性

类型:Version
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DscResourcesToExport

指定模块导出哪些 Desired State Configuration (DSC) 资源。 允许使用通配符。

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ExternalModuleDependencies

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-FileList

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-FormatsToProcess

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

导入模块时,PowerShell 使用指定的文件运行 Update-FormatData cmdlet。 由于没有确定格式设置文件的作用域,因此它们会影响会话中的所有会话状态。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-FunctionsToExport

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

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Guid

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

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HelpInfoUri

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

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

参数属性

类型:Uri
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IconUri

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

参数属性

类型:Uri
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LicenseUri

指定模块许可条款的 URL。

参数属性

类型:Uri
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ModuleList

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

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

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

参数属性

类型:

Object[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ModuleVersion

指定模块的版本。

参数属性

类型:Version
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-NestedModules

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

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

参数属性

类型:

Object[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Path

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PowerShellHostName

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

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PowerShellHostVersion

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

参数属性

类型:Version
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PowerShellVersion

指定适用于此模块的 PowerShell 的最低版本。 例如,可以指定 5.17.2等版本。

参数属性

类型:Version
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Prerelease

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PrivateData

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

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProcessorArchitecture

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

此参数的可接受值为:

  • Amd64
  • Arm
  • IA64
  • MSIL
  • None(未知或未指定)
  • X86

参数属性

类型:ProcessorArchitecture
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProjectUri

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

参数属性

类型:Uri
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReleaseNotes

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RequiredAssemblies

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

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RequiredModules

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

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

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

参数属性

类型:

Object[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RequireLicenseAcceptance

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RootModule

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

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

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ScriptsToProcess

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

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Tags

指定一个标签数组。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False
别名:标记

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-TypesToProcess

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

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VariablesToExport

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

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

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

None

输出

Object

备注

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