New-Module
创建一个仅存在于内存中的新动态模块。
语法
New-Module
[-ScriptBlock] <ScriptBlock>
[-Function <String[]>]
[-Cmdlet <String[]>]
[-ReturnResult]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[<CommonParameters>]
New-Module
[-Name] <String>
[-ScriptBlock] <ScriptBlock>
[-Function <String[]>]
[-Cmdlet <String[]>]
[-ReturnResult]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[<CommonParameters>]
说明
cmdlet New-Module
从脚本块创建动态模块。 动态模块的成员(如函数和变量)在会话中立即可用并保持可用状态,直到关闭此会话。
类似于静态模块,默认情况下,将导出动态模块中的 cmdlet 和函数,而不导出变量和别名。 但是,可以使用 Export-ModuleMember cmdlet 和 的参数 New-Module
替代默认值。
还可以使用 的 AsCustomObject 参数 New-Module
将动态模块作为自定义对象返回。 将模块的成员(例如函数)实现为自定义对象的脚本方法,而不是将其导入到会话中。
动态模块仅存在于内存中,而不存在于磁盘上。 类似于所有模块,动态模块的成员在专用模块作用域中运行,此作用域是全局作用域的子级。 Get-Module 无法获取动态模块,但 Get-Command 可以获取导出的成员。
若要使动态模块可用于 Get-Module
,请通过管道 New-Module
将命令传递给 Import-Module,或者通过管道将返回 的模块对象 New-Module
传递给 Import-Module
。 此操作将动态模块添加到 Get-Module
列表中,但它不会将模块保存到磁盘或使其保持不变。
示例
示例 1:Create动态模块
此示例使用名为 的 Hello
函数创建新的动态模块。 此命令返回表示新的动态模块的模块对象。
New-Module -ScriptBlock {function Hello {"Hello!"}}
Name : __DynamicModule_2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Path : 2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
示例 2:使用动态模块以及 Get-Module 和 Get-Command
此示例演示 cmdlet 不返回 Get-Module
动态模块。 cmdlet 将返回 Get-Command
它们导出的成员。
new-module -scriptblock {function Hello {"Hello!"}}
Name : __DynamicModule_2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Path : 2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
Get-Module
Get-Command Hello
CommandType Name Definition
----------- ---- ----------
Function Hello "Hello!"
示例 3:将变量导出到当前会话
此示例使用 Export-ModuleMember
cmdlet 将变量导出到当前会话中。
Export-ModuleMember
如果没有 命令,则仅导出函数。
New-Module -ScriptBlock {$SayHelloHelp="Type 'SayHello', a space, and a name."; function SayHello ($name) { "Hello, $name" }; Export-ModuleMember -function SayHello -Variable SayHelloHelp}
$SayHelloHelp
Type 'SayHello', a space, and a name.
SayHello Jeffrey
Hello, Jeffrey
输出显示已将变量和函数导出到会话中。
示例 4:使动态模块可用于 Get-Module
此示例演示可以通过将动态模块管道传递给 Import-Module
来使动态模块可供 使用Get-Module
。
New-Module
创建通过管道传递给 cmdlet 的 Import-Module
模块对象。 的 New-Module
Name 参数将友好名称分配给模块。 由于 Import-Module
默认情况下不返回任何对象,因此此命令没有输出。 Get-Module
GreetingModule 已导入当前会话。
New-Module -ScriptBlock {function Hello {"Hello!"}} -name GreetingModule | Import-Module
Get-Module
Name : GreetingModule
Path : d54dfdac-4531-4db2-9dec-0b4b9c57a1e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
Get-Command hello
CommandType Name Definition
----------- ---- ----------
Function Hello "Hello!"
cmdlet Get-Command
显示 Hello
动态模块导出的函数。
示例 5:生成具有导出函数的自定义对象
此示例演示如何使用 的 New-Module
AsCustomObject 参数生成具有表示导出函数的脚本方法的自定义对象。
cmdlet New-Module
创建具有两个函数 的动态模块: Hello
和 Goodbye
。 AsCustomObject 参数创建自定义对象,而不是默认生成的 PSModuleInfo 对象New-Module
。 此自定义对象保存在 变量中 $m
。
变量 $m
似乎没有赋值。
$m = New-Module -ScriptBlock {
function Hello ($name) {"Hello, $name"}
function Goodbye ($name) {"Goodbye, $name"}
} -AsCustomObject
$m
$m | Get-Member
TypeName: System.Management.Automation.PSCustomObject
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
Goodbye ScriptMethod System.Object Goodbye();
Hello ScriptMethod System.Object Hello();
$m.goodbye("Jane")
Goodbye, Jane
$m.hello("Manoj")
Hello, Manoj
通过 $m
管道连接到 Get-Member
cmdlet 会显示自定义对象的属性和方法。 输出显示对象具有表示 和 Goodbye
函数的Hello
脚本方法。
最后,调用这些脚本方法并显示结果。
示例 6:获取脚本块的结果
此示例使用 ReturnResult 参数请求运行脚本块的结果,而不是请求模块对象。 新模块中的脚本块定义 函数, SayHello
然后调用 函数。
New-Module -ScriptBlock {function SayHello {"Hello, World!"}; SayHello} -ReturnResult
Hello, World!
参数
-ArgumentList
指定参数数组,这些参数是传递给脚本块的参数值。 有关 ArgumentList 行为的详细信息,请参阅 about_Splatting。
Type: | Object[] |
Aliases: | Args |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AsCustomObject
指示此 cmdlet 返回表示动态模块的自定义对象。 将模块成员实现为自定义对象的脚本方法,但是不将它们导入到会话中。 可以在变量中保存自定义对象,并使用点表示法来调用成员。
如果模块具有多个同名的成员(例如一个函数和一个名为 A 的变量),则只能从自定义对象访问每个名称的一个成员。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Cmdlet
指定此 cmdlet 从模块导出到当前会话的 cmdlet 数组。 输入以逗号分隔的 cmdlet 列表。 允许使用通配符。 默认情况下,导出模块中的所有 cmdlet。
你无法在脚本块中定义 cmdlet,但如果从二进制模块导入 cmdlet,则动态模块可以包含 cmdlet。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Function
指定此 cmdlet 从模块导出到当前会话的函数数组。 输入以逗号分隔的函数列表。 允许使用通配符。 默认情况下,导出模块中定义的所有函数。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Name
指定新模块的名称。 还可以通过管道将模块的名称传递给 New-Module。
默认值是自动生成的名称,以 开头 __DynamicModule_
,后跟指定动态模块路径的 GUID。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ReturnResult
指示此 cmdlet 运行脚本块并返回脚本块结果,而不是返回模块对象。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScriptBlock
指定动态模块的内容。 将内容括在大括号 ({}
) 以创建脚本块。 此参数是必需的。
Type: | ScriptBlock |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
输入
可以通过管道将模块名称传递给此 cmdlet。
输出
System.Management.Automation.PSModuleInfo, System.Management.Automation.PSCustomObject, or None
默认情况下,此 cmdlet 生成 PSModuleInfo 对象。 如果使用 AsCustomObject 参数,它将生成 PSCustomObject 对象。 如果使用 ReturnResult 参数,它将返回计算动态模块中的脚本块的结果。
备注
还可以通过其别名 nmo
来引用 New-Module
。 有关详细信息,请参阅 about_Aliases。