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>]説明
コマンドレットは New-Module 、スクリプト ブロックから動的モジュールを作成します。 関数や変数などの動的モジュールのメンバーは、セッションで直ちに利用可能になり、セッションを終了するまで使用できます。
静的モジュール同様、既定では動的モジュール内のコマンドレットと関数がエクスポートされ、変数およびエイリアスはありません。 ただし、Export-ModuleMember コマンドレットと のパラメーター 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 の操作
この例では、 コマンドレットによって動的モジュールが返されないことを Get-Module 示します。 エクスポートするメンバーは、 コマンドレットによって 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 使用して変数を現在のセッションにエクスポートします。
コマンドを使用 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 で使用できるようにする
この例では、動的モジュールを に Get-Module パイプ処理することで、動的モジュール Import-Moduleを に使用できることを示します。
New-Module は、 コマンドレットにパイプされるモジュール オブジェクトを Import-Module 作成します。 の New-ModuleName パラメーターは、モジュールにフレンドリ名を割り当てます。 は既定ではオブジェクトを返さないため Import-Module 、このコマンドからの出力はありません。 Get-ModuleGreetingModule が現在のセッションにインポートされていること。
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!"コマンドレットは Get-Command 、動的モジュールが Hello エクスポートする関数を示します。
例 5: 関数をエクスポートしたカスタム オブジェクトを生成する
この例では、 の AsCustomObject パラメーター New-Module を使用して、エクスポートされた関数を表すスクリプト メソッドを持つカスタム オブジェクトを生成する方法を示します。
コマンドレットは New-Module 、 と の 2 つの関数 Hello を持つ動的モジュールを Goodbye作成します。 AsCustomObject パラメーターは、既定で生成される New-ModulePSModuleInfo オブジェクトの代わりにカスタム オブジェクトを作成します。 このカスタム オブジェクトは 変数に $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 、カスタム オブジェクトのプロパティとメソッドが表示されます。 出力は、 オブジェクトに および 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
このコマンドレットは、動的モジュールを表すカスタム オブジェクトを返します。 モジュールのメンバーは、カスタム オブジェクトのスクリプト メソッドとして実装されますが、セッションにインポートされません。 カスタム オブジェクトを変数に保存し、ドット表記を使用してメンバーを呼び出すことができます。
モジュールに同じ名前の複数のメンバー (関数と両方とも A という名前の変数など) がある場合、カスタム オブジェクトからアクセスできるのは、各名前のメンバーが 1 つだけです。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Cmdlet
このコマンドレットがモジュールから現在のセッションにエクスポートするコマンドレットの配列を指定します。 コマンドレットのコンマ区切りのリストを入力します。 ワイルドカード文字を使用できます。 既定では、モジュール内のすべてのコマンドレットがエクスポートされます。
スクリプト ブロック内のコマンドレットは定義できませんが、コマンドレットがバイナリ モジュールからインポートされた場合、動的モジュールがコマンドレットを含めることができます。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Function
このコマンドレットがモジュールから現在のセッションにエクスポートする関数の配列を指定します。 関数のコンマ区切りのリストを入力します。 ワイルドカード文字を使用できます。 既定では、モジュールで定義されたすべての関数がエクスポートされます。
| 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
このコマンドレットによってスクリプト ブロックが実行され、モジュール オブジェクトを返すのではなく、スクリプト ブロックの結果が返されることを示します。
| 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 |
入力
モジュール名をこのコマンドレットにパイプできます。
出力
System.Management.Automation.PSModuleInfo, System.Management.Automation.PSCustomObject, or None
このコマンドレットは、既定で PSModuleInfo オブジェクトを生成します。 AsCustomObject パラメーターを使用すると、PSCustomObject オブジェクトが生成されます。 ReturnResult パラメーターを使用すると、動的モジュールでスクリプト ブロックを評価した結果が返されます。
メモ
別名 で nmoをNew-Module参照することもできます。 詳細については、「about_Aliases」を参照してください。