Update-PSModuleManifest
更新模块清单文件。
语法
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
此示例将 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
指定模块导出的别名。 允许使用通配符。
| 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
指定模块所需的 Microsoft .NET Framework (CLR) 公共语言运行时的最低版本。
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CmdletsToExport
指定模块导出的 cmdlet。 允许使用通配符。
| 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
指定模块的兼容 PSEdition 。 有关 PSEdition 的信息，请参阅 具有兼容 PowerShell 版本的模块。
| Type: | String[] |
| Accepted values: | Desktop, Core |
| Position: | Named |
| Default value: | None |
| 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 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: | True |
-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 包含指定文件的 cmdlet。
由于格式化文件未限定范围，因此它们会影响会话中的所有会话状态。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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
指定模块的 HelpInfo XML 文件的 Internet 地址。 输入以 或 https:开头http:的统一资源标识符 (URI) 。
有关详细信息，请参阅 可更新的帮助。
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUri
指定模块图标的 URI。 指定的图标显示在模块的库网页上。
| 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 |
-Path
指定模块清单的路径和文件名。 输入文件扩展名为 .psd1 的文件名。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellHostName
指定模块所需的 PowerShell 主机程序的名称。 输入主机程序的名称，例如 PowerShell ISE Host 或 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 的最低版本。 例如，可以指定 版本，例如 5.1 或 7.2。
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Prerelease
指定追加到模块版本的预发行版值。 例如，如果 Prerelease 为 preview ， ModuleVersion 为 1.0.0，则模块的版本为 1.0.0-preview。
| 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
指定模块需要的处理器体系结构。
此参数的可接受值为：
Amd64ArmIA64MSILNone(未知或未指定)X86
| Type: | ProcessorArchitecture |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectUri
指定有关此项目的网页的 URI。
| 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 键中指定的模块文件之前加载指定的程序集。
对必须加载的程序集使用 RequiredAssemblies 以更新 FormatsToProcess 或 TypesToProcess 键中列出的任何格式设置或类型文件，即使这些程序集也列在 NestedModules 键中。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredModules
指定必须处于全局会话状态的模块。 如果所需的模块不处于全局会话状态，PowerShell 会导入它们。 如果所需的模块不可用，则 Import-Module 命令将失败。
该值可以是包含模块名称或模块规范的数组。 模块规范是具有以下键的哈希表。
ModuleName- 必填 指定模块名称。GUID- 选 指定模块的 GUID。- 还需要指定以下三个键中的至少一个。
ModuleVersion- 指定模块的最低可接受版本。MaximumVersion- 指定模块的最大可接受版本。RequiredVersion- 指定模块的确切所需版本。 这不能与其他版本密钥一起使用。
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireLicenseAcceptance
指定模块需要接受许可证。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RootModule
指定模块的主文件或根文件。 输入脚本 () .ps1 的文件名、脚本模块 () .psm1 、模块清单 (.psd1) 、程序集 (.dll) 或 cmdlet 定义 XML 文件 (.cdxml) 。 导入模块时，从根模块导出的成员将导入调用方会话状态。
如果模块具有清单文件，并且 RootModule 键中未指定任何文件，则清单将成为该模块的主文件。 该模块称为 moduleType =
Manifest) (清单模块。
若要从 .psm1 或 .dll 文件导出成员，必须在清单中的 RootModule 或 NestedModules 键的值中指定这些文件的名称。
| 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[] |
| Aliases: | Tag |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TypesToProcess
指定导入模块时运行 (.ps1xml) 的类型文件。
导入模块时，PowerShell 会 Update-TypeData 运行包含指定文件的 cmdlet。
由于类型文件未限定范围，因此它们会影响会话中的所有会话状态。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VariablesToExport
指定模块导出的变量。 允许使用通配符。
使用此参数可限制模块导出的变量。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
输入
None
输出
备注
有关模块清单文件的完整说明，请参阅 about_Module_Manifests。
相关链接
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈