Export-CrescendoModule

从 PowerShell Crescendo JSON 配置文件创建模块

语法

Default (默认值)

Export-CrescendoModule
    [-ConfigurationFile] <String[]>
    [-ModuleName] <String>
    [-Force]
    [-NoClobberManifest]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

此 cmdlet 导出可转换为充当特定于平台命令的代理的函数的对象。 生成的模块文件应可执行到 PowerShell 版本 5.1。

该 cmdlet 创建模块 .psm1 和模块清单 .psd1 文件。 当自定义模块清单超出 Crescendo 范围时,这可能导致问题。 使用 NoClobberManifest 参数防止覆盖清单。

示例

示例 1

Export-CrescendoModule -ModuleName netsh -ConfigurationFile netsh*.json
Import-Module ./netsh.psm1

示例 2

Export-CrescendoModule netsh netsh*.json -force

参数

-ConfigurationFile

这是表示模块代理的 JSON 文件列表。

参数属性

类型:

String[]

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

参数集

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

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

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

参数集

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

-Force

默认情况下,如果 Export-CrescendoModule 不会覆盖现有模块。 使用 Force 参数覆盖现有文件,或在运行 Export-CrescendoModule之前将其删除。

参数属性

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

参数集

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

-ModuleName

要创建的模块文件的名称。 可以省略尾随 .psm1

参数属性

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

参数集

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

-NoClobberManifest

防止覆盖模块清单。

必须使用任何新的 cmdlet 和设置手动更新清单。

参数属性

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

参数集

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

-PassThru

发出一个对象,其中包含 .psm1 的路径和 New-ModuleManifest 的参数。

参数属性

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

参数集

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未能运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

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

CommonParameters

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

输入

String

输出

Object

备注

在内部,此函数调用返回命令对象的 Import-CommandConfiguration cmdlet。 然后,ConfigurationFile 参数中提供的所有文件用于创建每个单独的函数。 最后,所有代理都用于创建 Export-ModuleMember 命令调用,因此导入生成的模块时,该模块具有所有可用的命令代理。

Export-CrescendoModule 将 crescendoBuilt 标记添加到模块清单。 可以使用此标记在使用 Crescendo 创建的 PowerShell 库中查找模块。 有关详细信息,请参见: