Import-Module
現在のセッションにモジュールを追加します。
構文
Name (既定)
Import-Module
[-Name] <String[]>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-MinimumVersion <Version>]
[-MaximumVersion <String>]
[-RequiredVersion <Version>]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
PSSession
Import-Module
[-Name] <String[]>
-PSSession <PSSession>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-MinimumVersion <Version>]
[-MaximumVersion <String>]
[-RequiredVersion <Version>]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
CimSession
Import-Module
[-Name] <String[]>
-CimSession <CimSession>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-MinimumVersion <Version>]
[-MaximumVersion <String>]
[-RequiredVersion <Version>]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[-CimResourceUri <Uri>]
[-CimNamespace <String>]
[<CommonParameters>]
UseWindowsPowerShell
Import-Module
[-Name] <string[]>
-UseWindowsPowerShell
[-Global]
[-Prefix <string>]
[-Function <string[]>]
[-Cmdlet <string[]>]
[-Variable <string[]>]
[-Alias <string[]>]
[-Force]
[-PassThru]
[-AsCustomObject]
[-MinimumVersion <version>]
[-MaximumVersion <string>]
[-RequiredVersion <version>]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <string>]
[<CommonParameters>]
FullyQualifiedName
Import-Module
[-FullyQualifiedName] <ModuleSpecification[]>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
FullyQualifiedNameAndPSSession
Import-Module
[-FullyQualifiedName] <ModuleSpecification[]>
-PSSession <PSSession>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
FullyQualifiedNameAndUseWindowsPowerShell
Import-Module
[-FullyQualifiedName] <ModuleSpecification[]>
-UseWindowsPowerShell
[-Global]
[-Prefix <string>]
[-Function <string[]>]
[-Cmdlet <string[]>]
[-Variable <string[]>]
[-Alias <string[]>]
[-Force]
[-PassThru]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <string>]
[<CommonParameters>]
Assembly
Import-Module
[-Assembly] <Assembly[]>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
ModuleInfo
Import-Module
[-ModuleInfo] <PSModuleInfo[]>
[-Global]
[-Prefix <String>]
[-Function <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[-Force]
[-SkipEditionCheck]
[-PassThru]
[-AsCustomObject]
[-ArgumentList <Object[]>]
[-DisableNameChecking]
[-NoClobber]
[-Scope <String>]
[<CommonParameters>]
説明
Import-Module コマンドレットは、現在のセッションに 1 つ以上のモジュールを追加します。 PowerShell 3.0 以降では、モジュール内のコマンドまたはプロバイダーを使用すると、インストールされているモジュールがセッションに自動的にインポートされます。 ただし、 Import-Module コマンドを使用してモジュールをインポートすることはできます。
$PSModuleAutoLoadingPreference基本設定変数を使用して、モジュールの自動インポートを無効にすることができます。
$PSModuleAutoLoadingPreference 変数の詳細については、about_Preference_Variablesを参照してください。
モジュールは、PowerShell で使用できるメンバーを含むパッケージです。 メンバーには、コマンドレット、プロバイダー、スクリプト、関数、変数、およびその他のツールとファイルが含まれます。 モジュールがインポートされたら、セッションでモジュール メンバーを使用できます。 モジュールの詳細については、about_Modulesを参照してください。
既定では、 Import-Module モジュールによってエクスポートされるすべてのメンバーがインポートされますが、 Alias、 Function、 Cmdlet、 Variable パラメーターを使用して、インポートするメンバーを制限できます。
NoClobber パラメーターを指定すると、Import-Moduleは現在のセッションのメンバーと同じ名前のメンバーをインポートできなくなります。
Import-Module は、モジュールを現在のセッションにのみインポートします。 新しいセッションごとにモジュールをインポートするには、PowerShell プロファイルに Import-Module コマンドを追加します。 プロファイルの詳細については、about_Profilesを参照してください。
PowerShell リモート処理が有効になっているリモート Windows コンピューターは、リモート コンピューターで PSSession を作成することで管理できます。 次に、Import-Moduleの PSSession パラメーターを使用して、リモート コンピューターにインストールされているモジュールをインポートします。 現在のセッションでインポートされたコマンドを使用すると、コマンドはリモート コンピューターで暗黙的に実行されます。
Windows PowerShell 3.0 以降では、Import-Module を使用して共通情報モデル (CIM) モジュールをインポートできます。 CIM モジュールは、コマンドレット定義 XML (CDXML) ファイルでコマンドレットを定義します。 この機能を使用すると、C++ で記述されたコマンドレットなど、非マネージド コード アセンブリに実装されているコマンドレットを使用できます。
Windows オペレーティング システムを実行していないコンピューターなど、PowerShell リモート処理が有効になっていないリモート コンピューターの場合は、Import-Module の CimSession パラメーターを使用して、リモート コンピューターから CIM モジュールをインポートできます。 インポートされたコマンドは、リモート コンピューターで暗黙的に実行されます。
CIMSession は、リモート コンピューター上の Windows Management Instrumentation (WMI) への接続です。
例
例 1: モジュールのメンバーを現在のセッションにインポートする
次の使用例は、 PSDiagnostics モジュールのメンバーを現在のセッションにインポートします。
Import-Module -Name PSDiagnostics
例 2: モジュール パスで指定されたすべてのモジュールをインポートする
次の使用例は、 $Env:PSModulePath 環境変数で指定されたパス内のすべての使用可能なモジュールを現在のセッションにインポートします。
Get-Module -ListAvailable | Import-Module
例 3: 複数のモジュールのメンバーを現在のセッションにインポートする
この例では、 PSDiagnostics モジュールと Dism モジュールのメンバーを現在のセッションにインポートします。
$m = Get-Module -ListAvailable PSDiagnostics, Dism
Import-Module -ModuleInfo $m
Get-Module コマンドレットは PSDiagnostics モジュールと Dism モジュールを取得し、オブジェクトを $m 変数に保存します。
ListAvailable パラメーターは、まだセッションにインポートされていないモジュールを取得するときに必要です。
Import-Moduleの ModuleInfo パラメーターは、モジュールを現在のセッションにインポートするために使用されます。
例 4: パスで指定されたすべてのモジュールをインポートする
この例では、明示的なパスを使用して、インポートするモジュールを識別します。
Import-Module -Name C:\ps-test\modules\test -Verbose
VERBOSE: Loading module from path 'C:\ps-test\modules\Test\Test.psm1'.
VERBOSE: Exporting function 'my-parm'.
VERBOSE: Exporting function 'Get-Parameter'.
VERBOSE: Exporting function 'Get-Specification'.
VERBOSE: Exporting function 'Get-SpecDetails'.
Verbose パラメーターを使用すると、モジュールの読み込み時にImport-Moduleが進行状況を報告します。
Verbose、PassThru、または AsCustomObject パラメーターがない場合、Import-Moduleはモジュールをインポートするときに出力を生成しません。
例 5: セッションにインポートされるモジュール メンバーを制限する
この例では、セッションにインポートするモジュール メンバーを制限する方法と、このコマンドがセッションに及ぼす影響を示します。 Function パラメーターは、モジュールからインポートされるメンバーを制限します。 Alias、Variable、および Cmdlet パラメーターを使用して、モジュールがインポートする他のメンバーを制限することもできます。
Get-Module コマンドレットは、PSDiagnostics モジュールを表すオブジェクトを取得します。
ExportedCmdlets プロパティは、すべてインポートされていない場合でも、モジュールがエクスポートするすべてのコマンドレットを一覧表示します。
Import-Module PSDiagnostics -Function Disable-PSTrace, Enable-PSTrace
(Get-Module PSDiagnostics).ExportedCommands
Key Value
--- -----
Disable-PSTrace Disable-PSTrace
Disable-PSWSManCombinedTrace Disable-PSWSManCombinedTrace
Disable-WSManTrace Disable-WSManTrace
Enable-PSTrace Enable-PSTrace
Enable-PSWSManCombinedTrace Enable-PSWSManCombinedTrace
Enable-WSManTrace Enable-WSManTrace
Get-LogProperties Get-LogProperties
Set-LogProperties Set-LogProperties
Start-Trace Start-Trace
Stop-Trace Stop-Trace
Get-Command -Module PSDiagnostics
CommandType Name Version Source
----------- ---- ------- ------
Function Disable-PSTrace 6.1.0.0 PSDiagnostics
Function Enable-PSTrace 6.1.0.0 PSDiagnostics
Get-Command コマンドレットの Module パラメーターを使用すると、PSDiagnostics モジュールからインポートされたコマンドが表示されます。 結果は、 Disable-PSTrace コマンドレットと Enable-PSTrace コマンドレットのみがインポートされたことを確認します。
例 6: モジュールのメンバーをインポートし、プレフィックスを追加する
次の使用例は、 PSDiagnostics モジュールを現在のセッションにインポートし、メンバー名にプレフィックスを追加して、プレフィックス付きのメンバー名を表示します。
Import-Moduleの Prefix パラメーターは、モジュールからインポートされるすべてのメンバーにxプレフィックスを追加します。 プレフィックスは、現在のセッションのメンバーにのみ適用されます。 モジュールは変更されません。
PassThru パラメーターは、インポートされたモジュールを表すモジュール オブジェクトを返します。
Import-Module PSDiagnostics -Prefix x -PassThru
ModuleType Version Name ExportedCommands
---------- ------- ---- ----------------
Script 6.1.0.0 PSDiagnostics {Disable-xPSTrace, Disable-xPSWSManCombinedTrace, Disable-xW...
Get-Command -Module PSDiagnostics
CommandType Name Version Source
----------- ---- ------- ------
Function Disable-xPSTrace 6.1.0.0 PSDiagnostics
Function Disable-xPSWSManCombinedTrace 6.1.0.0 PSDiagnostics
Function Disable-xWSManTrace 6.1.0.0 PSDiagnostics
Function Enable-xPSTrace 6.1.0.0 PSDiagnostics
Function Enable-xPSWSManCombinedTrace 6.1.0.0 PSDiagnostics
Function Enable-xWSManTrace 6.1.0.0 PSDiagnostics
Function Get-xLogProperties 6.1.0.0 PSDiagnostics
Function Set-xLogProperties 6.1.0.0 PSDiagnostics
Function Start-xTrace 6.1.0.0 PSDiagnostics
Function Stop-xTrace 6.1.0.0 PSDiagnostics
Get-Command は、モジュールからインポートされたメンバーを取得します。 出力は、モジュール メンバーに正しいプレフィックスが付いていたことを示しています。
例 7: カスタム オブジェクトを取得して使用する
この例では、 Import-Moduleによって返されるカスタム オブジェクトを取得して使用する方法を示します。
カスタム オブジェクトには、インポートされた各モジュール メンバーを表す合成メンバーが含まれます。 たとえば、モジュール内のコマンドレットと関数は、カスタム オブジェクトのスクリプト メソッドに変換されます。
カスタム オブジェクトは、スクリプト作成に役立ちます。 インポートされた複数のオブジェクトの名前が同じである場合にも便利です。 オブジェクトのスクリプト メソッドの使用は、インポートされたメンバーの完全修飾名 (モジュール名を含む) を指定することと同じです。
AsCustomObject パラメーターは、スクリプト モジュールをインポートする場合にのみ使用できます。
Get-Moduleを使用して、使用可能なモジュールのうちスクリプト モジュールを特定します。
Get-Module -List | Format-Table -Property Name, ModuleType -AutoSize
Name ModuleType
---- ----------
Show-Calendar Script
BitsTransfer Manifest
PSDiagnostics Manifest
TestCmdlets Script
...
$a = Import-Module -Name Show-Calendar -AsCustomObject -PassThru
$a | 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()
Show-Calendar ScriptMethod System.Object Show-Calendar();
$a."Show-Calendar"()
Show-Calendar スクリプト モジュールは、カスタム オブジェクトを要求する AsCustomObject パラメーターと、オブジェクトを返す PassThru パラメーターを使用してインポートされます。 結果のカスタム オブジェクトは、 $a 変数に保存されます。
$a変数は、保存されたオブジェクトのプロパティとメソッドを表示するために、Get-Member コマンドレットにパイプされます。 出力には、 Show-Calendar スクリプト メソッドが表示されます。
Show-Calendar スクリプト メソッドを呼び出すには、名前にハイフンが含まれているため、メソッド名を引用符で囲む必要があります。
例 8: モジュールを同じセッションに再インポートする
この例では、モジュールを同じセッションに再インポートするときに、Import-Moduleの Force パラメーターを使用する方法を示します。
Force パラメーターは、読み込まれたモジュールを削除し、再度インポートします。
Import-Module PSDiagnostics
Import-Module PSDiagnostics -Force -Prefix PS
最初のコマンドは PSDiagnostics モジュールを インポートします。 2 番目のコマンドは、 今度は Prefix パラメーターを使用してモジュールを再度インポートします。
Force パラメーターを指定しない場合、セッションには各 PSDiagnostics コマンドレットの 2 つのコピーが含まれます。1 つは標準名で、1 つはプレフィックス付きの名前です。
例 9: インポートされたコマンドによって非表示にされたコマンドを実行する
この例では、インポートされたコマンドによって非表示にされたコマンドを実行する方法を示します。
TestModule モジュールには、年と日を返す Get-Date という名前の関数が含まれています。
Get-Date
Thursday, August 15, 2019 2:26:12 PM
Import-Module TestModule
Get-Date
19227
Get-Command Get-Date -All | Format-Table -Property CommandType, Name, ModuleName -AutoSize
CommandType Name ModuleName
----------- ---- ----------
Function Get-Date TestModule
Cmdlet Get-Date Microsoft.PowerShell.Utility
Microsoft.PowerShell.Utility\Get-Date
Thursday, August 15, 2019 2:28:31 PM
最初の Get-Date コマンドレットは、現在の日付を持つ DateTime オブジェクトを返します。
TestModule モジュールをインポートした後、Get-Dateは年と日を返します。
Get-Commandの All パラメーターを使用すると、セッション内のすべてのGet-Dateコマンドが表示されます。 結果は、セッションに 2 つの Get-Date コマンド、TestModule モジュールの関数、および Microsoft のコマンドレットがあることを示しています。PowerShell.Utility モジュール。
関数はコマンドレットよりも優先されるため、testModule モジュールのGet-Date関数は、Get-Date コマンドレットではなく実行されます。
Get-Dateの元のバージョンを実行するには、コマンド名をモジュール名で修飾する必要があります。
PowerShell でのコマンドの優先順位の詳細については、「about_Command_Precedence」を参照 してください。
例 10: モジュールの最小バージョンをインポートする
この例では、 PowerShellGet モジュールをインポートします。
Import-Moduleの MinimumVersion パラメーターを使用して、モジュールのバージョン 2.0.0以上のみをインポートします。
Import-Module -Name PowerShellGet -MinimumVersion 2.0.0
RequiredVersion パラメーターを使用してモジュールの特定のバージョンをインポートしたり、#Requires キーワードの Module パラメーターと Version パラメーターを使用してスクリプト内のモジュールの特定のバージョンを要求したりすることもできます。
例 11: 完全修飾名を使用してインポートする
この例では、 FullyQualifiedName を使用してモジュールの特定のバージョンをインポートします。
PS> Get-Module -ListAvailable PowerShellGet | Select-Object Name, Version
Name Version
---- -------
PowerShellGet 2.2.1
PowerShellGet 2.1.3
PowerShellGet 2.1.2
PowerShellGet 1.0.0.1
PS> Import-Module -FullyQualifiedName @{ModuleName = 'PowerShellGet'; ModuleVersion = '2.1.3' }
例 12: 完全修飾パスを使用してインポートする
この例では、完全修飾パスを使用して、モジュールの特定のバージョンをインポートします。
PS> Get-Module -ListAvailable PowerShellGet | Select-Object Path
Path
----
C:\Program Files\PowerShell\Modules\PowerShellGet\2.2.1\PowerShellGet.psd1
C:\Program Files\PowerShell\6\Modules\PowerShellGet\PowerShellGet.psd1
C:\Program Files\WindowsPowerShell\Modules\PowerShellGet\2.1.2\PowerShellGet.psd1
C:\Program Files\WindowsPowerShell\Modules\PowerShellGet\1.0.0.1\PowerShellGet.psd1
PS> Import-Module -Name 'C:\Program Files\PowerShell\Modules\PowerShellGet\2.2.1\PowerShellGet.psd1'
例 13: リモート コンピューターからモジュールをインポートする
この例では、 Import-Module コマンドレットを使用してリモート コンピューターからモジュールをインポートする方法を示します。
このコマンドでは、PowerShell の暗黙的なリモート処理機能を使用します。
別のセッションからモジュールをインポートする場合は、現在のセッションでコマンドレットを使用できます。 ただし、コマンドレットを使用するコマンドはリモート セッションで実行されます。
$s = New-PSSession -ComputerName Server01
Get-Module -PSSession $s -ListAvailable -Name NetSecurity
ModuleType Name ExportedCommands
---------- ---- ----------------
Manifest NetSecurity {New-NetIPsecAuthProposal, New-NetIPsecMainModeCryptoProposal, New-Ne...
Import-Module -PSSession $s -Name NetSecurity
Get-Command -Module NetSecurity -Name Get-*Firewall*
CommandType Name ModuleName
----------- ---- ----------
Function Get-NetFirewallAddressFilter NetSecurity
Function Get-NetFirewallApplicationFilter NetSecurity
Function Get-NetFirewallInterfaceFilter NetSecurity
Function Get-NetFirewallInterfaceTypeFilter NetSecurity
Function Get-NetFirewallPortFilter NetSecurity
Function Get-NetFirewallProfile NetSecurity
Function Get-NetFirewallRule NetSecurity
Function Get-NetFirewallSecurityFilter NetSecurity
Function Get-NetFirewallServiceFilter NetSecurity
Function Get-NetFirewallSetting NetSecurity
Get-NetFirewallRule -DisplayName "Windows Remote Management*" |
Format-Table -Property DisplayName, Name -AutoSize
DisplayName Name
----------- ----
Windows Remote Management (HTTP-In) WINRM-HTTP-In-TCP
Windows Remote Management (HTTP-In) WINRM-HTTP-In-TCP-PUBLIC
Windows Remote Management - Compatibility Mode (HTTP-In) WINRM-HTTP-Compat-In-TCP
New-PSSessionは、Server01 コンピューターへのリモート セッション (PSSession) を作成します。
PSSession は、$s変数に保存されます。
PSSession パラメーターを使用してGet-Moduleを実行すると、NetSecurity モジュールがリモート コンピューターにインストールされ、使用可能であることが示されます。 このコマンドは、 Invoke-Command コマンドレットを使用してリモート セッションでコマンド Get-Module 実行することと同じです。 例えば次が挙げられます。
Invoke-Command $s {Get-Module -ListAvailable -Name NetSecurity
PSSession パラメーターを使用してImport-Moduleを実行すると、NetSecurity モジュールがリモート コンピューターから現在のセッションにインポートされます。
Get-Command コマンドレットは、Getで始まり、NetSecurity モジュールからFirewallを含むコマンドを取得します。 出力は、モジュールとそのコマンドレットが現在のセッションにインポートされたことを確認します。
次に、Get-NetFirewallRule コマンドレットは、Server01 コンピューターでリモート管理ファイアウォール規則Windows取得します。 これは、 Invoke-Command コマンドレットを使用してリモート セッションで Get-NetFirewallRule を実行するのと同じです。
例 14: Windows オペレーティング システムを使用せずにリモート コンピューター上の記憶域を管理する
この例では、コンピューターの管理者がモジュール検出 WMI プロバイダーをインストールしました。これにより、プロバイダー用に設計された CIM コマンドを使用できます。
New-CimSession コマンドレットは、RSDGF03という名前のリモート コンピューターにセッションを作成します。 セッションは、リモート コンピューター上の WMI サービスに接続します。 CIM セッションは、 $cs 変数に保存されます。
Import-Moduleでは、$csの CimSession を使用して、RSDGF03 コンピューターからストレージ CIM モジュールをインポートします。
Get-Command コマンドレットは、Storage モジュールの Get-Disk コマンドを表示します。 CIM モジュールをローカル セッションにインポートすると、PowerShell は各コマンドの CDXML ファイルを PowerShell スクリプトに変換します。これは、ローカル セッションの関数として表示されます。
Get-Diskはローカル セッションで入力されますが、コマンドレットはインポート元のリモート コンピューターで暗黙的に実行されます。 このコマンドは、リモート コンピューターからローカル セッションにオブジェクトを返します。
$cs = New-CimSession -ComputerName RSDGF03
Import-Module -CimSession $cs -Name Storage
# Importing a CIM module, converts the CDXML files for each command into
# PowerShell scripts. These appear as functions in the local session.
Get-Command Get-Disk
CommandType Name ModuleName
----------- ---- ----------
Function Get-Disk Storage
# Use implicit remoting to query disks on the remote computer from which the
# module was imported.
Get-Disk
Number Friendly Name OperationalStatus Total Size Partition Style
------ ------------- ----------------- ---------- ---------------
0 Virtual HD ATA Device Online 40 GB MBR
パラメーター
-Alias
このコマンドレットがモジュールから現在のセッションにインポートするエイリアスを指定します。 エイリアスのコンマ区切りの一覧を入力します。 ワイルドカード文字を使用できます。
一部のモジュールでは、モジュールをインポートすると、選択したエイリアスがセッションに自動的にエクスポートされます。 このパラメーターを使用すると、エクスポートされたエイリアスの中から選択できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ArgumentList
Import-Module コマンド中にスクリプト モジュールに渡される引数またはパラメーター値の配列を指定します。 このパラメーターは、スクリプト モジュールをインポートする場合にのみ有効です。
ArgumentList パラメーターは、エイリアス args を使用して参照することもできます。 ArgumentListの動作 (
パラメーターのプロパティ
| 型: | Object[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | 引数 |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AsCustomObject
このコマンドレットは、インポートされたモジュール メンバーを表すメンバーを持つカスタム オブジェクトを返します。 このパラメーターは、スクリプト モジュールに対してのみ有効です。
AsCustomObject パラメーターを使用すると、Import-Moduleモジュール メンバーがセッションにインポートされ、PSModuleInfo オブジェクトではなく PSCustomObject オブジェクトが返されます。 カスタム オブジェクトを変数に保存し、メンバー アクセス列挙を使用してメンバーを呼び出すことができます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Assembly
アセンブリ オブジェクトの配列を指定します。 このコマンドレットは、指定したアセンブリ オブジェクトに実装されているコマンドレットとプロバイダーをインポートします。 アセンブリ オブジェクトを含む変数、またはアセンブリ オブジェクトを作成するコマンドを入力します。 アセンブリ オブジェクトをパイプ処理して Import-Moduleすることもできます。
このパラメーターを使用すると、指定したアセンブリによって実装されたコマンドレットとプロバイダーのみがインポートされます。 モジュールに他のファイルが含まれている場合、それらはインポートされず、モジュールの重要なメンバーが見つからない可能性があります。 このパラメーターは、モジュールのデバッグとテスト、またはモジュール作成者によって使用するように指示された場合に使用します。
パラメーターのプロパティ
| 型: | Assembly[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Assembly
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CimNamespace
CIM モジュールを公開する代替 CIM プロバイダーの名前空間を指定します。 既定値は、モジュール探索 WMI プロバイダーの名前空間です。
Windows オペレーティング システムを実行していないコンピューターおよびデバイスから CIM モジュールをインポートするには、このパラメーターを使用します。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CimResourceUri
CIM モジュールの別の場所を指定します。 既定値は、リモート コンピューター上のモジュール探索 WMI プロバイダーのリソース URI です。
Windows オペレーティング システムを実行していないコンピューターおよびデバイスから CIM モジュールをインポートするには、このパラメーターを使用します。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | Uri |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CimSession
リモート コンピューター上の CIM セッションを指定します。 CIM セッションを含む変数、または CIM セッションを取得するコマンド ( Get-CimSession コマンドなど) を入力します。
Import-Module は CIM セッション接続を使用して、リモート コンピューターから現在のセッションにモジュールをインポートします。 現在のセッションでインポートされたモジュールのコマンドを使用すると、リモート コンピューターでコマンドが実行されます。
このパラメーターを使用すると、Windows オペレーティング システムを実行していないコンピューターやデバイス、および PowerShell を使用しているが PowerShell リモート処理が有効になっていないコンピューター Windowsからモジュールをインポートできます。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | CimSession |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CimSession
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Cmdlet
このコマンドレットがモジュールから現在のセッションにインポートするコマンドレットの配列を指定します。 ワイルドカード文字を使用できます。
一部のモジュールでは、モジュールをインポートすると、選択したコマンドレットがセッションに自動的にエクスポートされます。 このパラメーターを使用すると、エクスポートされたコマンドレットの中から選択できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DisableNameChecking
名前に未承認の動詞または禁止文字が含まれるコマンドレットまたは関数をインポートするときに警告するメッセージが、このコマンドレットによって抑制されることを示します。
既定では、インポートするモジュールが、名前に未承認の動詞を含むコマンドレットまたは関数をエクスポートすると、PowerShell によって次の警告メッセージが表示されます。
警告: 一部のインポートされたコマンド名には未承認の動詞が含まれており、見つけにくくなることがあります。 詳細または型 Get-Verb の詳細パラメーターを使用して、承認済みの動詞の一覧を表示します。
このメッセージは、警告のみです。 完全なモジュールは、準拠していないコマンドを含め、引き続きインポートされます。 メッセージはモジュール ユーザーに表示されますが、モジュールの作成者が名前付けの問題を修正する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
このパラメーターにより、モジュールが現在のモジュールの上に読み込まれるか、再読み込みされます。 一部のモジュールは外部アセンブリを読み込みます。 新しいバージョンのアセンブリを読み込むモジュールをインポートする場合、インポートは失敗します。 Force パラメーターはエラーをオーバーライドできません。 新しいバージョンを読み込むには、新しいセッションを開始する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-FullyQualifiedName
値には、モジュール名、完全なモジュール仕様、またはモジュール ファイルへのパスを指定できます。
値がパスの場合、パスは完全修飾または相対パスにすることができます。 相対パスは、using ステートメントを含むスクリプトを基準にして解決されます。
値が名前またはモジュールの指定である場合、PowerShell は指定されたモジュールの PSModulePath を検索します。
モジュール仕様は、次のキーを持つハッシュテーブルです。
-
ModuleName- 必須 モジュール名を指定します。 -
GUID- 省略可能 モジュールの GUID を指定します。 - また、以下の 3 つのキーのうち少なくとも 1 つを指定Required です。
-
ModuleVersion- モジュールの最小許容バージョンを指定します。 -
MaximumVersion- モジュールの許容される最大バージョンを指定します。 -
RequiredVersion- モジュールの正確で必要なバージョンを指定します。 これは、他のバージョン キーでは使用できません。
-
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
FullyQualifiedName
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedNameAndPSSession
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedNameAndWinCompat
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Function
このコマンドレットがモジュールから現在のセッションにインポートする関数の配列を指定します。 ワイルドカード文字を使用できます。 一部のモジュールでは、モジュールをインポートすると、選択した関数がセッションに自動的にエクスポートされます。 このパラメーターを使用すると、エクスポートされた関数の中から選択できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Global
このコマンドレットは、モジュールをグローバル セッション状態にインポートして、セッション内のすべてのコマンドで使用できるようにすることを示します。
既定では、コマンド プロンプト、スクリプト ファイル、または scriptblock から Import-Module コマンドレットが呼び出されると、すべてのコマンドがグローバル セッション状態にインポートされます。
別のモジュールから呼び出されると、 Import-Module コマンドレットは、入れ子になったモジュールからのコマンドを含むモジュール内のコマンドを呼び出し元のモジュールのセッション状態にインポートします。
ヒント
モジュール内から Import-Module を呼び出さないようにする必要があります。 代わりに、親モジュールのマニフェストで、入れ子になったモジュールとしてターゲット モジュールを宣言します。 入れ子になったモジュールを宣言すると、依存関係の検出可能性が向上します。
Global パラメーターは、値が Global の Scope パラメーターと同じです。
モジュールがエクスポートするコマンドを制限するには、スクリプト モジュールで Export-ModuleMember コマンドを使用します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MaximumVersion
最大バージョンを指定します。 このコマンドレットは、指定した値以下のバージョンのモジュールのみをインポートします。 該当するバージョンがない場合、 Import-Module はエラーを返します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Name
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
PSSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
WinCompat
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MinimumVersion
最小バージョンを指定します。 このコマンドレットは、指定した値以上のバージョンのモジュールのみをインポートします。
MinimumVersion パラメーター名またはそのエイリアス Version を使用します。 該当するバージョンがない場合、 Import-Module はエラーを生成します。
正確なバージョンを指定するには、 RequiredVersion パラメーターを使用します。 #Requires キーワードの Module パラメーターと Version パラメーターを使用して、スクリプト内のモジュールの特定のバージョンを要求することもできます。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | Version |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | Version |
パラメーター セット
Name
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
PSSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
WinCompat
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModuleInfo
インポートするモジュール オブジェクトの配列を指定します。 モジュール オブジェクトを含む変数、またはモジュール オブジェクトを取得するコマンド (次のコマンドなど) を入力します: Get-Module -ListAvailable。 モジュール オブジェクトをパイプして Import-Moduleすることもできます。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ModuleInfo
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
インポートするモジュールの名前を指定します。 モジュールの名前、またはモジュール内のファイルの名前 ( .psd1、 .psm1、 .dll、 .ps1 ファイルなど) を入力します。 ファイル パスは省略可能です。 ワイルドカード文字は使用できません。 また、モジュール名とファイル名をパイプして Import-Moduleすることもできます。
パスを省略した場合、 Import-Module は、 $Env:PSModulePath 環境変数に保存されているパスでモジュールを検索します。
可能な限り、モジュール名のみを指定してください。 ファイル名を指定すると、そのファイルに実装されているメンバーのみがインポートされます。 モジュールに他のファイルが含まれている場合、それらはインポートされず、モジュールの重要なメンバーが見つからない可能性があります。
Note
スクリプト (.ps1) ファイルをモジュールとしてインポートすることは可能ですが、スクリプト ファイルは通常、スクリプト モジュール ファイル (.psm1) ファイルのように構造化されていません。 スクリプト ファイルをインポートしても、モジュールとして使用できる保証はありません。 詳細については、「 about_Modules」を参照してください。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
Name
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
PSSession
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSession
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
WinCompat
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoClobber
現在のセッションの既存のコマンドと同じ名前のコマンドをインポートできないようにします。 既定では、 Import-Module はエクスポートされたすべてのモジュール コマンドをインポートします。
同じ名前のコマンドは、セッション内のコマンドを非表示にしたり置き換えたりできます。 セッションでコマンド名の競合を回避するには、 Prefix パラメーターまたは NoClobber パラメーターを 使用します。 名前の競合とコマンドの優先順位の詳細については、about_Modulesとabout_Command_Precedenceの「モジュールと名前の競合」を参照してください。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | NoOverwrite |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
インポートされたモジュールを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Prefix
このコマンドレットが、インポートされたモジュール メンバーの名前の名詞に追加するプレフィックスを指定します。
セッション内の異なるメンバーが同じ名前を持つ場合に発生する可能性がある名前の競合を回避するには、このパラメーターを使用します。 このパラメーターはモジュールを変更せず、モジュールが独自にインポートするファイルには影響しません。 これらは入れ子になったモジュールと呼ばれます。 このコマンドレットは、現在のセッションのメンバーの名前にのみ影響します。
たとえば、プレフィックス UTC を指定し、 Get-Date コマンドレットをインポートした場合、このコマンドレットはセッションで Get-UTCDateと認識され、元の Get-Date コマンドレットと混同されません。
このパラメーターの値は、既定のプレフィックスを指定するモジュールの DefaultCommandPrefix プロパティよりも優先されます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PSSession
このコマンドレットがモジュールを現在のセッションにインポートする PowerShell ユーザー管理セッション (PSSession) を指定します。
PSSession を含む変数、または PSSession を取得するコマンド (Get-PSSession コマンドなど) を入力します。
別のセッションから現在のセッションにモジュールをインポートする場合は、ローカル モジュールのコマンドレットを使用する場合と同様に、現在のセッションのモジュールのコマンドレットを使用できます。 リモート コマンドレットを使用するコマンドはリモート セッションで実行されますが、リモート処理の詳細は PowerShell によってバックグラウンドで管理されます。
このパラメーターでは、PowerShell の暗黙的なリモート処理機能を使用します。
Import-PSSession コマンドレットを使用してセッションから特定のモジュールをインポートするのと同じです。
Import-Module では、コア PowerShell モジュールを別のセッションからインポートできません。 コア PowerShell モジュールには、Microsoftで始まる名前があります。Powershell。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | PSSession |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
PSSession
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedNameAndPSSession
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RequiredVersion
このコマンドレットがインポートするモジュールのバージョンを指定します。 バージョンがインストールされていない場合、 Import-Module はエラーを生成します。
既定では、 Import-Module はバージョン番号を確認せずにモジュールをインポートします。
最小バージョンを指定するには、 MinimumVersion パラメーターを使用します。 #Requires キーワードの Module パラメーターと Version パラメーターを使用して、スクリプト内のモジュールの特定のバージョンを要求することもできます。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
RequiredVersion を使用して、Windows オペレーティング システムの既存のリリースに含まれるモジュールをインポートするスクリプトは、Windows オペレーティング システムの今後のリリースでは自動的に実行されません。 これは、Windows オペレーティング システムの将来のリリースの PowerShell モジュールのバージョン番号が、Windows オペレーティング システムの既存のリリースのモジュール バージョン番号よりも大きくなるためです。
パラメーターのプロパティ
| 型: | Version |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Name
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
PSSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
WinCompat
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
モジュールをインポートするスコープを指定します。
このパラメーターに使用できる値は次のとおりです。
- グローバル。 セッション内のすべてのコマンドで使用できます。 Global パラメーターと同じです。
- ローカル。 現在のスコープでのみ使用できます。
既定では、コマンド プロンプト、スクリプト ファイル、または scriptblock から Import-Module コマンドレットが呼び出されると、すべてのコマンドがグローバル セッション状態にインポートされます。
-Scope Local パラメーターを使用して、モジュールコンテンツをスクリプトまたはスクリプトブロックスコープにインポートできます。
別のモジュールから呼び出されると、 Import-Module コマンドレットは、入れ子になったモジュールからのコマンドを含むモジュール内のコマンドを呼び出し元のセッション状態にインポートします。
-Scope Globalまたは-Globalを指定すると、このコマンドレットはモジュールをグローバル セッション状態にインポートして、セッション内のすべてのコマンドで使用できるようにすることを示します。
Global パラメーターは、値が Global の Scope パラメーターと同じです。
このパラメーターは、Windows PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| 指定可能な値: | Local, Global |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipEditionCheck
CompatiblePSEditions フィールドのチェックをスキップします。
モジュールが CompatiblePSEditions マニフェスト フィールドにCoreを指定していない場合に、"$($Env:windir)\System32\WindowsPowerShell\v1.0\Modules" モジュール ディレクトリから PowerShell Core にモジュールを読み込みます。
別のパスからモジュールをインポートする場合、チェックは実行されないため、このスイッチは何も行いません。 Linux および macOS では、このスイッチは何も行いません。
詳細については、「 about_PowerShell_Editions」を参照してください。
Warning
Import-Module -SkipEditionCheck は、モジュールのインポートに失敗する可能性があります。 成功した場合でも、互換性のない API を使用しようとすると、モジュールからのコマンドの呼び出しが後で失敗する可能性があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Name
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
PSSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedNameAndPSSession
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
Assembly
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ModuleInfo
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseWindowsPowerShell
Windows PowerShell 互換性機能を使用してモジュールを読み込みます。 詳細については、 about_Windows_PowerShell_Compatibility を参照してください。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | UseWinPS |
パラメーター セット
WinCompat
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FullyQualifiedNameAndWinCompat
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Variable
このコマンドレットがモジュールから現在のセッションにインポートする変数の配列を指定します。 変数の一覧を入力します。 ワイルドカード文字を使用できます。
一部のモジュールでは、モジュールをインポートすると、選択した変数がセッションに自動的にエクスポートされます。 このパラメーターを使用すると、エクスポートされた変数の中から選択できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
入力
String
モジュール名をこのコマンドレットにパイプできます。
PSModuleInfo
モジュール オブジェクトをこのコマンドレットにパイプできます。
Assembly
アセンブリ オブジェクトをこのコマンドレットにパイプできます。
出力
None
既定では、このコマンドレットは出力を返しません。
PSModuleInfo
PassThru パラメーターを指定すると、インポートされたモジュールを表す System.Management.Automation.PSModuleInfo オブジェクトが生成されます。
PSCustomObject
AsCustomObject パラメーターと PassThru パラメーターを一緒に指定すると、モジュールを表す PSCustomObject オブジェクトが生成されます。
メモ
PowerShell には、Import-Moduleの次のエイリアスが含まれています。
すべてのプラットフォーム:
ipmo
モジュールをインポートする前に、モジュールにローカル コンピューターからアクセスでき、
PSModulePath環境変数に含まれている必要があります。 詳細については、「 about_Modules」を参照してください。PSSession パラメーターと CimSession パラメーターを使用して、リモート コンピューターにインストールされているモジュールをインポートすることもできます。 ただし、これらのモジュールのコマンドレットを使用するコマンドは、リモート コンピューター上のリモート セッションで実行されます。
同じ名前と同じ種類のメンバーをセッションにインポートする場合、PowerShell では既定で最後にインポートされたメンバーが使用されます。 変数とエイリアスは置き換えられ、元の変数にはアクセスできません。 関数、コマンドレット、およびプロバイダーは、新しいメンバーによってシャドウされるだけです。 アクセスするには、スナップイン、モジュール、または関数パスの名前でコマンド名を修飾します。
モジュールからインポートされたコマンドの書式設定データを更新するには、
Update-FormatDataコマンドレットを使用します。 モジュールの書式設定ファイルが変更された場合は、Update-FormatDataコマンドレットを使用して、インポートされたコマンドの書式設定データを更新します。 モジュールをもう一度インポートする必要はありません。Windows PowerShell 3.0 以降では、PowerShell と共にインストールされるコア コマンドはモジュールにパッケージ化されています。 Windows PowerShell 2.0 と、それ以降のバージョンの PowerShell で古いスタイルのセッションを作成するホスト プログラムでは、コア コマンドはスナップイン (PSSnapins) にパッケージ化されます。 例外は Microsoft です。PowerShell.Core。これは常にスナップインです。 また、
New-PSSessionコマンドレットによって開始されたリモート セッションは、コア スナップインを含む古いスタイルのセッションです。コア モジュールで新しいスタイルのセッションを作成する CreateDefault2 メソッドの詳細については、「 CreateDefault2 メソッド」を参照してください。
Windows PowerShell 2.0 では、モジュール オブジェクトの一部のプロパティ値 (ExportedCmdlets、NestedModules プロパティ値など) は、モジュールがインポートされるまで設定されませんでした。
Windows PowerShell 3.0 以降と互換性のない混合モード アセンブリを含むモジュールをインポートしようとすると、
Import-Moduleは次のようなエラー メッセージを返します。Import-Module : 混合モード アセンブリは、ランタイムのバージョン 'v2.0.50727' に対してビルドされ、追加の構成情報がないと 4.0 ランタイムに読み込めません。
このエラーは、Windows PowerShell 2.0 用に設計されたモジュールに少なくとも 1 つの混合モジュール アセンブリが含まれている場合に発生します。 C++ や C# などのマネージド コードと非マネージド コードの両方を含む混合モジュール アセンブリ。
混合モード アセンブリを含むモジュールをインポートするには、次のコマンドを使用して PowerShell 2.0 Windows開始し、
Import-Moduleコマンドをもう一度試します。powershell.exe -Version 2.0CIM セッション機能を使用するには、リモート コンピューターにリモート処理とWindows管理インストルメンテーション (WMI) が WS-Management 必要です。これは、共通情報モデル (CIM) 標準のMicrosoft実装です。 コンピューターには、モジュール検出 WMI プロバイダーまたは同じ基本機能を持つ代替 CIM プロバイダーも必要です。
CIM セッション機能は、Windows オペレーティング システムを実行していないコンピューターと、PowerShell が有効になっていても PowerShell リモート処理が有効になっていないWindowsコンピューターで使用できます。
CIM パラメーターを使用して、PowerShell リモート処理が有効になっているコンピューター (ローカル コンピューターを含む) から CIM モジュールを取得することもできます。 ローカル コンピューターで CIM セッションを作成すると、PowerShell は WMI ではなく DCOM を使用してセッションを作成します。
既定では、
Import-Moduleは、子孫スコープから呼び出された場合でも、グローバル スコープ内のモジュールをインポートします。 最上位レベルのスコープとすべての子孫スコープは、モジュールのエクスポートされた要素にアクセスできます。子孫スコープでは、
-Scope Localはインポートをそのスコープとそのすべての子孫スコープに制限します。 親スコープには、インポートされたメンバーは表示されません。Note
Get-Moduleには、現在のセッションに読み込まれているすべてのモジュールが表示されます。 これには、子孫スコープにローカルに読み込まれたモジュールが含まれます。Get-Command -Module modulenameを使用して、現在のスコープに読み込まれているメンバーを確認します。Import-Moduleでは、モジュール内のクラス定義と列挙定義は読み込まれません。 スクリプトの先頭にあるusing moduleステートメントを使用します。 これにより、クラスと列挙型の定義を含むモジュールがインポートされます。 詳細については、「about_Using」を参照してください。スクリプト モジュールの開発中は、コードに変更を加え、
Import-Moduleパラメーターで を使用して新しいバージョンのモジュールを読み込むのが一般的です。 これは、ルート モジュール内の関数に対する変更に対してのみ機能します。Import-Moduleは、入れ子になったモジュールを再読み込みしません。 また、更新されたクラスや列挙型を読み込む方法はありません。入れ子になったモジュールで定義されている更新されたモジュール メンバーを取得するには、
Remove-Moduleでモジュールを削除してから、モジュールをもう一度インポートします。モジュールが
usingステートメントで読み込まれた場合は、新しいセッションを開始して、クラスと列挙型の更新された定義をインポートする必要があります。 PowerShell で定義され、usingステートメントでインポートされたクラスと列挙型はアンロードできません。