New-Module

New-Module [-Name] <string> [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-関数 <string[]>] [-ReturnResult] [<CommonParameters>]

New-Module [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-関数 <string[]>] [-ReturnResult] [<CommonParameters>]

C:\PS>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     : {}

説明
-----------
このコマンドは、"Hello" という関数を含む新しい動的モジュールを作成します。また、新しい動的モジュールを表すモジュール オブジェクトを返します。

C:\PS>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     : {}

C:\PS> get-module
C:\PS>

C:\PS> get-command Hello

CommandType     Name   Definition
-----------     ----   ----------
Function        Hello  "Hello!"

説明
-----------
この例では、動的モジュールは Get-Module コマンドレットによって返されず、モジュールからエクスポートされたメンバーが Get-Command コマンドレットによって返されることを示しています。

C:\PS>New-Module -scriptblock {$SayHelloHelp="Type 'SayHello', a space, and a name."; function SayHello ($name) { "Hello, $name" }; Export-ModuleMember -function SayHello -Variable SayHelloHelp}

C:\PS> $SayHelloHelp
Type 'SayHello', a space, and a name.

C:\PS> SayHello Jeffrey
Hello, Jeffrey

説明
-----------
このコマンドは、Export-ModuleMember コマンドレットを使用して、変数を現在のセッションにエクスポートします。Export-ModuleMember コマンドを指定しない場合、関数のみがエクスポートされます。

出力には、変数と関数の両方がセッションにエクスポートされたことが示されます。

C:\PS>new-module -scriptblock {function Hello {"Hello!"}} -name GreetingModule | import-module

C:\PS> 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     : {}


C:\PS> get-command hello

CommandType     Name                                                               Definition
-----------     ----                                                               ----------
Function        Hello                                                              "Hello!"

説明
-----------
このコマンドは、動的モジュールを Get-Module コマンドレットで利用可能にできることを示しており、これを行うために、パイプを使用して動的モジュールを Import-Module コマンドレットに渡しています。

最初のコマンドは、パイプライン演算子 (|) を使用して、New-Module で生成されたモジュール オブジェクトを Import-Module コマンドレットに送ります。このコマンドは、New-Module の Name パラメーターを使用して、モジュールにフレンドリ名を割り当てます。既定では、Import-Module はオブジェクトを返さないため、このコマンドからの出力はありません。

2 番目のコマンドは、Get-Module コマンドレットを使用して、セッションのモジュールを取得します。結果には、Get-Module で新しい動的モジュールを取得できることが示されています。

3 番目のコマンドは、Get-Command コマンドレットを使用して、動的モジュールからエクスポートされた Hello 関数を取得します。

C:\PS>$m = new-module -scriptblock {function Hello ($name) {"Hello, $name"}; function Goodbye ($name) {"Goodbye, $name"}} -AsCustomObject

C:\PS> $m

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

PS C:\ps-test> $m.goodbye("Jane")
Goodbye, Jane

PS C:\ps-test> $m.hello("Manoj")
Hello, Manoj

PS C:\ps-test> goodbye Jane
Goodbye, Jane

PS C:\ps-test> hello Manoj
Hello, Manoj

説明
-----------
この例は、New-Module の AsCustomObject パラメーターを使用して、エクスポートされた関数を表すスクリプト メソッドを含むカスタム オブジェクトを生成する方法を示しています。

最初のコマンドは、New-Module コマンドレットを使用して、2 つの関数 Hello および Goodbye を含む動的モジュールを生成します。このコマンドは AsCustomObject パラメーターを使用して、既定で New-Module が生成する PSModuleInfo オブジェクトではなく、カスタム オブジェクトを生成します。また、カスタム オブジェクトを $m 変数に保存します。

2 番目のコマンドは、$m 変数の値を表示しようとします。内容は表示されません。

3 番目のコマンドは、パイプライン演算子 (|) を使用して、カスタム オブジェクトを Get-Member コマンドレットに送信します。このコマンドレットは、カスタム オブジェクトのプロパティとメソッドを表示します。出力には、Hello 関数と Goodbye 関数を表すスクリプト メソッドがオブジェクトに含まれることが示されます。

 4 番目と 5 番目のコマンドは、スクリプト メソッドの形式を使用して、Hello 関数と Goodbye 関数を呼び出します。
 
6 番目と 7 番目のコマンドは、関数名とパラメーター値を指定すると、関数を呼び出します。

C:\PS>new-module -scriptblock {function SayHello {"Hello, World!"}; SayHello} -returnResult

Hello, World!

説明
-----------
このコマンドは、ReturnResult パラメーターを使用し、モジュール オブジェクトを要求するのではなく、スクリプト ブロックの実行結果を要求します。

新しいモジュールのスクリプト ブロックは、SayHello 関数を定義してから関数を呼び出します。