导入 PowerShell 模块

  • 项目

将模块安装到系统后，可能需要导入模块。 导入是将模块加载到活动内存中，使用户可以在其 PowerShell 会话中访问该模块的过程。 在 PowerShell 2.0 中，可以通过调用 import-module cmdlet 来导入新安装的 PowerShell 模块。 在 PowerShell 3.0 中，当用户调用模块中的一个函数或 cmdlet 时，PowerShell 能够隐式导入模块。 请注意，这两个版本都假设您将模块安装在 PowerShell 能够找到它的位置;有关详细信息，请参阅 安装 PowerShell 模块。 您可以使用模块清单来限制导出模块的哪些部分，并且可以使用调用的参数 Import-Module 来限制导入的部件。

导入 Snap-In (PowerShell 1.0)

PowerShell 1.0 中不存在模块：相反，你必须注册并使用管理单元。但建议您不要在此时使用这种技术，因为模块通常更易于安装和导入。 有关详细信息，请参阅如何创建 Windows PowerShell 管理单元。

使用 Import-Module (PowerShell 2.0 导入模块)

PowerShell 2.0 使用适当命名的 import-module cmdlet 导入模块。 运行此 cmdlet 时，Windows PowerShell 在变量中指定的目录中搜索指定的模块 PSModulePath 。 找到指定的目录时，Windows PowerShell 按以下顺序搜索文件：模块清单文件 ( psd1) 、脚本模块文件 (. hbase-runner.psm1) 、二进制模块文件 (.dll) 。 有关向搜索添加目录的详细信息，请参阅 about_PSModulePath。 下面的代码说明如何导入模块：

Import-Module myModule

假设 myModule 位于中 PSModulePath ，则 PowerShell 会将 myModule 加载到活动内存。 如果 myModule 不在某个路径上 PSModulePath ，你仍可以显式告知 PowerShell 在何处找到该路径：

Import-Module -Name C:\myRandomDirectory\myModule -Verbose

你还可以使用 -Verbose 参数来确定要从模块中导出的内容以及要导入到活动内存中的内容。 导出和导入会限制向用户公开的内容：区别在于控制可见性。 实质上，导出由模块内的代码控制。 与此相反，导入由 Import-Module 调用控制。 有关详细信息，请参阅下面的 限制导入的成员。

(PowerShell 3.0 隐式导入模块)

从 Windows PowerShell 3.0 开始，在命令中使用模块的任意 cmdlet 或函数时会自动导入该模块。 此功能适用于 PSModulePath 环境变量的值中包含的目录中的任何模块。 但是，如果您不将模块保存在有效路径上，则仍可以使用上面所述的显式 Import-module 选项加载它们。

以下操作触发自动导入模块，也称为 "模块自动加载"。

  • 在命令中使用 cmdlet。 例如，键入 Get-ExecutionPolicy "导入" "导入" Get-ExecutionPolicy 。

  • 使用 get-help cmdlet 获取命令。 例如，键入 Get-Command Get-JobTrigger 将导入包含该 cmdlet 的 PSScheduledJob 模块 Get-JobTrigger 。 Get-Command包含通配符的命令被视为发现，不会触发模块的导入。

  • 使用 get-help cmdlet 获取有关 cmdlet 的帮助。 例如，键入 Get-Help Get-WinEvent "导入" "导入" Get-WinEvent 。

为了支持模块的自动导入，该 Get-Command cmdlet 将获取所有已安装模块中的所有 cmdlet 和函数，即使模块未导入到会话中也是如此。 有关详细信息，请参阅 Get Command cmdlet 的帮助主题。

导入过程

在导入模块时，将为该模块创建一个新的会话状态，并在内存中创建一个 PSModuleInfo 对象。 将为每个导入的模块创建会话状态 (这包括根模块和任何嵌套的模块) 。 然后，将从根模块导出的成员（包括任何嵌套模块导出到根模块的所有成员）导入到调用方的会话状态中。

从模块导出的成员的元数据具有 ModuleName 属性。 此属性由导出的模块的名称填充。

警告

如果导出成员的名称使用未经批准的谓词，或如果该成员的名称使用受限字符，则在运行 import-module cmdlet 时，将显示一条警告。

默认情况下， import-module cmdlet 不会将任何对象返回到管道。 但是，该 cmdlet 支持 PassThru 参数，该参数可用于为导入的每个模块返回 PSModuleInfo 对象。 若要将输出发送到主机，用户应运行 写入主机 cmdlet。

限制导入的成员

当使用 import-module cmdlet 导入模块时，默认情况下，所有导出的模块成员都将导入到会话中，包括通过嵌套模块导出到该模块中的任何命令。 默认情况下，不导出变量和别名。 若要限制导出的成员，请使用 模块清单。 若要限制导入的成员，请使用 cmdlet 的以下参数 Import-Module 。

  • 函数：此参数限制导出的函数。 (如果使用的是模块清单，请参阅 FunctionsToExport 键。 )

  • `Cmdlet：如果使用模块清单，此参数会限制 (导出的 cmdlet，请参阅 CmdletsToExport 键。 )

  • 变量：如果使用模块清单，此参数会限制 (导出的变量，请参阅 VariablesToExport 键。 )

  • 别名：如果使用模块清单，此参数会限制 (导出的别名，请参阅 AliasesToExport 键。 )

另请参阅

编写 Windows PowerShell 模块