New-Module

リファレンス

モジュール:: Microsoft.PowerShell.Core

メモリ内にのみ存在する新しい動的モジュールを作成します。

構文

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、Import-Module にコマンドをNew-Moduleパイプするか、戻り値Import-ModuleのモジュールオブジェクトNew-Moduleをパイプ処理します。このアクションでは、Get-Module の一覧に動的モジュールが追加されますが、モジュールはディスクには保存されず、永続的になることもありません。

例

例 1: 動的モジュールを作成する

この例では、関数を使用 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 で動的モジュールを使用できるようにする

この例では、動的モジュールをパイプ処理して動的モジュールImport-ModuleをGet-Module使用できることを示します。

New-Module は、コマンドレットにパイプされるモジュールオブジェクトを Import-Module 作成します。 Name パラメーターはNew-Module、モジュールにフレンドリ名を割り当てます。 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-Module PSModuleInfo オブジェクトの代わりにカスタムオブジェクトを作成します。このカスタムオブジェクトは変数に $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 、カスタムオブジェクトのプロパティとメソッドが表示されます。出力は、オブジェクトに、および関数を表すHelloGoodbyeスクリプトメソッドがあることを示しています。最後に、これらのスクリプトメソッドを呼び出し、結果を表示します。

例 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

入力

String

モジュール名をこのコマンドレットにパイプできます。

出力

PSModuleInfo

このコマンドレットは、既定で PSModuleInfo オブジェクトを生成します。

PSCustomObject

AsCustomObject パラメーターを使用すると、PSCustomObject オブジェクトが生成されます。

Object

ReturnResult パラメーターを使用すると、このコマンドレットは動的モジュールでスクリプトブロックを評価した結果を返します。

メモ

Windows PowerShell には、次のエイリアスが New-Module含まれています。

nmo

エイリアスnmoで参照New-Moduleすることもできます。詳細については、「about_Aliases」を参照してください。

New-Module

構文

説明

例

例 1: 動的モジュールを作成する

例 2: 動的モジュールと Get-Module と Get-Command の操作

例 3: 変数を現在のセッションにエクスポートする

例 4: Get-Module で動的モジュールを使用できるようにする

例 5: エクスポートされた関数を含むカスタムオブジェクトを生成する

例 6: スクリプトブロックの結果を取得する

パラメーター

-ArgumentList

-AsCustomObject

-Cmdlet

-Function

-Name

-ReturnResult

-ScriptBlock

入力

出力

メモ

フィードバック

その他のリソース

New-Module

構文

説明

例

例 1: 動的モジュールを作成する

例 2: 動的モジュールと Get-Module と Get-Command の操作

例 3: 変数を現在のセッションにエクスポートする

例 4: Get-Module で動的モジュールを使用できるようにする

例 5: エクスポートされた関数を含むカスタム オブジェクトを生成する

例 6: スクリプト ブロックの結果を取得する

パラメーター

-ArgumentList

-AsCustomObject

-Cmdlet

-Function

-Name

-ReturnResult

-ScriptBlock

入力

出力

メモ

関連リンク

フィードバック

その他のリソース

例 5: エクスポートされた関数を含むカスタムオブジェクトを生成する

例 6: スクリプトブロックの結果を取得する