Import-Module

Import-Module [-Name] <string[]> [-エイリアス <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-関数 <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-変数 <string[]>] [-Version <Version>] [<CommonParameters>]

Import-Module [-Assembly] <Assembly[]> [-エイリアス <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-関数 <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-変数 <string[]>] [-Version <Version>] [<CommonParameters>]

Import-Module [-ModuleInfo] <PSModuleInfo[]> [-エイリアス <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-関数 <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-変数 <string[]>] [-Version <Version>] [<CommonParameters>]

C:\PS>import-module -name BitsTransfer

説明
-----------
このコマンドは、BitsTransfer モジュールのメンバーを現在のセッションにインポートします。

Name パラメーター名 (-Name) はオプションであるため、省略できます。

既定では、Import-Module はモジュールをインポートする際に出力を生成しません。出力を要求するには、PassThru パラメーターや AsCustomObject パラメーター、または Verbose 共通パラメーターを使用します。

C:\PS>get-module -listAvailable | import-module

説明
-----------
このコマンドは、PSModulePath 環境変数 ($env:psmodulepath) によって指定されたパスで利用可能なすべてのモジュールを、現在のセッションにインポートします。

C:\PS>$m = get-module -ListAvailable BitsTransfer, ServerBackup

C:\PS> import-module -moduleInfo $m

説明
-----------
これらのコマンドは、BitsTransfer モジュールと ServerBackup モジュールのメンバーを現在のセッションにインポートします。

最初のコマンドは、Get-Module コマンドレットを使用して、BitsTransfer モジュールと ServerBackup モジュールを表す PSModuleInfo オブジェクトを取得します。オブジェクトは $m 変数に保存されます。ListAvailable パラメーターは、セッションにまだインポートされていないモジュールを取得する場合は必須です。

2 番目のコマンドは、Import-Module の ModuleInfo パラメーターを使用して、モジュールを現在のセッションにインポートします。

これらのコマンドを実行すると、パイプライン演算子 (|) を使用して Get-Module コマンドの出力を Import-Module に送信した場合と同じ効果が得られます。

C:\PS>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-parm'.
VERBOSE: Exporting function 'get-spec'.
VERBOSE: Exporting function 'get-specDetails'.

説明
-----------
このコマンドは明示的なパスを使用して、インポートするモジュールを指定します。

また、Verbose 共通パラメーターを使用して、モジュールからインポートする項目の一覧を取得します。Verbose、PassThru、または AsCustomObject パラメーターが指定されていない場合、Import-Module はモジュールのインポート時に出力を生成しません。

C:\PS>import-module BitsTransfer -cmdlet Add-BitsTransferFile, Get-BitsTransfer

C:\PS> get-module BitsTransfer

Name              : BitsTransfer
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer\BitsTransfer.psd1
Description       :
Guid              : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version           : 1.0.0.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {[Add-BitsTransfer, Add-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer], [Get-BitsTransfer, Get-BitsTransfer], [Rem
                    ove-BitsTransfer, Remove-BitsTransfer]...}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {Microsoft.BackgroundIntelligentTransfer.Management}


C:\PS> get-command -module BitsTransfer

CommandType Name                Definition
----------- ----                ----------
Cmdlet      Add-BitsTransfer    Add-BitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> [[-Destination] <String[]>] [-Verbose] [-Debug] [-ErrorA...
Cmdlet      Get-BitsTransfer    Get-BitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningActi...

説明
-----------
この例は、セッションにインポートされたモジュール メンバーを制限する方法と、このコマンドがセッションに与える影響を示しています。

最初のコマンドは、BitsTransfer モジュールから Add-BitsTransfer および Get-BitsTransfer コマンドレットのみをインポートします。このコマンドは Cmdlet  パラメーターを使用して、モジュールがインポートするコマンドレットを制限します。Alias、Variable、および Function パラメーターを使用して、モジュールがインポートする他のメンバーを制限することもできます。

2 番目のコマンドは Get-Module コマンドレットを使用して、BitsTransfer モジュールを表すオブジェクトを取得します。ExportedCmdlets プロパティは、すべてがインポートされたかどうかにかかわらず、モジュールがエクスポートするすべてのコマンドレットを一覧表示します。

3 番目のコマンドは Get-Command コマンドレットの Module パラメーターを使用して、BitsTransfer モジュールからインポートされたコマンドを取得します。その結果から、Add-BitsTransfer および Get-BitsTransfer コマンドレットのみがインポートされたことを確認できます。

C:\PS>import-module BitsTransfer -prefix PS -passthru

Name              : bitstransfer
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer\bitstransfer.psd1
Description       :
Guid              : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version           : 1.0.0.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {[Add-BitsTransfer, Add-BitsTransfer], [Remove-BitsTransfer, Remove-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer]
                    , [Get-BitsTransfer, Get-BitsTransfer]...}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {Microsoft.BackgroundIntelligentTransfer.Management}


C:\PS> get-command -module bitstransfer

CommandType     Name                        Definition
-----------     ----                        ----------
Cmdlet          Add-PSBitsTransfer          Add-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> ...
Cmdlet          Complete-PSBitsTransfer     Complete-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Deb...
Cmdlet          Get-PSBitsTransfer          Get-PSBitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] ...
Cmdlet          Remove-PSBitsTransfer       Remove-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debug...
Cmdlet          Resume-PSBitsTransfer       Resume-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Asynchronous] [-...
Cmdlet          Set-PSBitsTransfer          Set-PSBitsTransfer [-BitsJob] <BitsJob[]> [-DisplayName <String...
Cmdlet          Start-PSBitsTransfer        Start-PSBitsTransfer [[-Source] <String[]>] [[-Destination] <St...
Cmdlet          Suspend-PSBitsTransfer      Suspend-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debu...

説明
-----------
これらのコマンドは、BitsTransfer モジュールを現在のセッションにインポートし、メンバー名にプレフィックスを追加してから、プレフィックスの付いたメンバー名を表示します。

最初のコマンドは、Import-Module コマンドレットを使用して BitsTransfer モジュールをインポートします。また、Prefix パラメーターを使用して、モジュールからインポートされるすべてのメンバーに PS というプレフィックスを追加し、PassThru パラメーターを使用して、インポートされたモジュールを表すモジュール オブジェクトを返します。

コマンドが返すモジュール オブジェクトには、エクスポートされたメンバーを一覧表示する ExportedCmdlets プロパティがあります。プレフィックスは、メンバーがエクスポートされた後、インポートされる前に適用されるため、コマンドレット名には表示されません。

2 番目のコマンドは Get-Command コマンドレットを使用して、モジュールからインポートされたメンバーを取得します。このコマンドは、Module パラメーターを使用してモジュールを指定します。出力から、モジュール メンバーにプレフィックスが正しく追加されたことがわかります。

使用するプレフィックスは、現在のセッションのメンバーのみに適用されます。モジュールは変更されません。

C:\PS>get-module -list | format-table -property name, moduletype -auto

Name          ModuleType
----          ----------
Show-Calendar     Script
BitsTransfer    Manifest
PSDiagnostics   Manifest
TestCmdlets       Script

C:\PS> $a = import-module -name Show-Calendar -asCustomObject

C:\PS> $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();

C:\PS> $a."show-calendar"()

説明
-----------
これらのコマンドは、Import-Module が返すカスタム オブジェクトの取得方法と使用方法を示します。

カスタム オブジェクトには、インポートされた各モジュール メンバーを表す合成メンバーが含まれます。たとえば、モジュールのコマンドレットおよび関数は、カスタム オブジェクトのスクリプト メソッドに変換されます。

カスタム オブジェクトはスクリプトに非常に役立ちます。また、インポートされた複数のオブジェクトが同じ名前を持つ場合にも役立ちます。オブジェクトのスクリプト メソッドを使用すると、モジュール名を含め、インポートされたメンバーの完全修飾名を指定した場合と同じ効果が得られます。

AsCustomObject パラメーターはスクリプト モジュールでのみ使用できるため、まず利用可能なモジュールのうちでどのモジュールがスクリプト モジュールかを決定します。

最初のコマンドは、Get-Module コマンドレットを使用して利用可能なモジュールを取得します。このコマンドはパイプライン演算子 (|) を使用して、モジュール オブジェクトを Format-Table コマンドレットに渡します。このコマンドレットは、各モジュールの Name および ModuleType を表形式で一覧表示します。

2 番目のコマンドは、Import-Module コマンドレットを使用して、Show-Calendar スクリプト モジュールをインポートします。このコマンドは AsCustomObject パラメーターを使用して、カスタム オブジェクトを要求します。このコマンドは、結果のカスタム オブジェクトを $a 変数に保存します。

3 番目のコマンドは、パイプライン演算子を使用して、$a 変数を Get-Member コマンドレットに送信します。このコマンドレットは、$a の PSCustomObject のプロパティとメソッドを取得します。出力には Show-Calendar スクリプト メソッドが示されます。

最後のコマンドは Show-Calendar スクリプト メソッドを使用します。メソッド名にはハイフンが含まれるため、引用符で囲む必要があります。

C:\PS>import-module BitsTransfer

C:\PS> import-module BitsTransfer -force -prefix PS

説明
-----------
この例は、モジュールを同じセッションに再インポートする場合に Import-Module の Force パラメーターを使用する方法を示しています。

最初のコマンドは BitsTransfer モジュールをインポートします。2 番目のコマンドは、今度は Prefix パラメーターを使用してモジュールをインポートします。

2 番目のコマンドには、モジュールを削除してから再インポートする Force パラメーターも含まれています。このパラメーターが指定されなかった場合、セッションに各 BitsTransfer コマンドレットのコピーが 2 つ含まれることになります (1 つは標準名、もう 1 つはプレフィックス付きの名前)。

C:\PS>get-date

Saturday, September 12, 2009 6:47:04 PM

C:\PS> import-module TestModule

C:\PS> get-date
09255

C:\PS> get-command get-date | format-table -property commandtype, name, pssnapin, module -auto

CommandType  Name       pssnapin                       Module
-----------  ----       --------                       ------
   Function  Get-Date                                  TestModule
     Cmdlet  Get-Date   Microsoft.PowerShell.Utility


C:\PS> Microsoft.PowerShell.Utility\get-date

Saturday, September 12, 2009 6:33:23 PM

説明
-----------
この例は、インポートされたコマンドによって隠れた状態になっているコマンドの実行方法を示しています。

最初のコマンドは、Windows PowerShell に付属の Get-Date コマンドレットを実行します。このコマンドは、現在の日付の DateTime オブジェクトを返します。

2 番目のコマンドは、TestModule モジュールをインポートします。このモジュールには、ユリウス暦の日付を返す Get-Date という名前の関数が含まれています。

3 番目のコマンドは Get-Date コマンドをもう一度実行します。関数はコマンドレットより優先されるため、Get-Date コマンドレットではなく、TestModule の Get-Date 関数が実行されました。

4 番目のコマンドは、セッションに 2 つの Get-Date コマンド (TestModule モジュールの関数と Microsoft.PowerShell.Utility スナップインのコマンドレット) があることを示します。

5 番目のコマンドは、コマンド名をスナップイン名で修飾して、隠れたコマンドレットを実行します。

Windows PowerShell のコマンド優先順位の詳細については、「about_command_precedence」を参照してください。