New-ModuleManifest

New-ModuleManifest
    [-Path] <string>
    [-NestedModules <Object[]>]
    [-Guid <guid>]
    [-Author <string>]
    [-CompanyName <string>]
    [-Copyright <string>]
    [-RootModule <string>]
    [-ModuleVersion <version>]
    [-Description <string>]
    [-ProcessorArchitecture <ProcessorArchitecture>]
    [-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 <Object>]
    [-Tags <string[]>]
    [-ProjectUri <uri>]
    [-LicenseUri <uri>]
    [-IconUri <uri>]
    [-ReleaseNotes <string>]
    [-HelpInfoUri <string>]
    [-PassThru]
    [-DefaultCommandPrefix <string>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-ModuleManifest cmdlet 将创建新的模块清单（.psd1）文件，填充其值，并将清单文件保存在指定的路径中。

模块作者可以使用此 cmdlet 为其模块创建清单。 模块清单是包含哈希表的 .psd1 文件。 哈希表中的键和值描述了模块的内容和属性，定义先决条件，并确定组件的处理方式。 模块并非一定需要清单。

New-ModuleManifest 创建包含所有常用清单键的清单，以便可以将默认输出用作清单模板。 若要添加或更改值，或添加此 cmdlet 未添加的模块键，请在文本编辑器中打开生成的文件。

每个参数（Path 和 PassThru除外）都会创建模块清单密钥及其值。 在模块清单中，只需要 ModuleVersion 密钥。 除非在参数说明中指定，否则如果省略命令中的参数，New-ModuleManifest 为无效的关联值创建注释字符串。

在 PowerShell 2.0 中，除了必需的参数值外，New-ModuleManifest 还会提示输入命令中未指定的常用参数的值。 从 PowerShell 3.0 开始，只有在未指定必需的参数值时，New-ModuleManifest 才会提示。

此示例在由 Path 参数指定的文件中创建新的模块清单。 PassThru 参数将输出发送到管道和文件。

输出显示清单中所有键的默认值。

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 1/22/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '1.0'

# ID used to uniquely identify this module
GUID = '47179120-0bcb-4f14-8d80-f4560107f85c'

# Author of this module
Author = 'ContosoAdmin'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2019 ContosoAdmin. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of the .NET Framework required by this module
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module
FunctionsToExport = '*'

# Cmdlets to export from this module
CmdletsToExport = '*'

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module
AliasesToExport = '*'

# List of all modules packaged with this module.
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess
# PrivateData = ''

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

此示例创建新的模块清单。 它使用 PowerShellVersion 和 AliasesToExport 参数，将数值添加到相应的清单密钥中。

New-ModuleManifest -PowerShellVersion 1.0 -AliasesToExport JKBC, DRC, TAC -Path C:\ps-test\ManifestTest.psd1

此示例使用字符串格式指定 BitsTransfer 模块的名称和哈希表格式来指定名称、GUID以及 PSScheduledJob 模块的版本。

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

此示例演示如何使用 ModuleList、RequiredModules和 NestedModules 参数的字符串和哈希表格式。 可以在同一参数值中合并字符串和哈希表。

此示例使用 HelpInfoUri 参数在模块清单中创建 HelpInfoUri 键。 参数和键的值必须以 http 或 https开头。 此值告诉可更新帮助系统在哪里可以找到该模块的 HelpInfo XML 帮助信息文件。

$moduleSettings = @{
  HelpInfoUri = 'https://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

有关可更新的帮助的信息，请参阅 about_Updatable_Help。 有关 HelpInfo XML 文件的信息，请参阅支持可更新的帮助。

此示例演示如何获取模块的配置值。 模块清单中的值反映在模块对象的属性值中。

Get-Module cmdlet 用于使用 List 参数获取 Microsoft.PowerShell.Diagnostics 模块。 该命令将模块发送到 Format-List cmdlet 以显示模块对象的所有属性和值。

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

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

无法通过管道将输入传递给此 cmdlet。

默认情况下，New-ModuleManifest 不会生成任何输出。 但是，如果使用 PassThru 参数，它将生成表示模块清单的 System.String 对象。

创建编码为 UTF16的模块清单（） 文件。

模块清单通常是可选的。 但是，导出全局程序集缓存中安装的程序集需要模块清单。

若要在 $pshome\Modules 目录中添加或更改文件，请使用 以管理员身份运行 选项启动 PowerShell。

在 PowerShell 2.0 中，New-ModuleManifest 的许多参数被设定为必需，即便它们在模块清单中不是必须的。 从 PowerShell 3.0 开始，只有 Path 参数是必需的。

会话是 PowerShell 执行环境的实例。 会话可以有一个或多个会话状态。 默认情况下，会话只有全局会话状态，但每个导入的模块都有自己的会话状态。 会话状态允许模块中的命令在不影响全局会话状态的情况下运行。

调用方会话状态是将模块导入到的会话状态。 通常，它是指全局会话状态，但当模块导入嵌套模块时，调用方是模块，调用方会话状态是模块的会话状态。