共用方式為


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>]

Description

New-Module Cmdlet 會從腳本區塊建立動態模組。 動態模組的成員,例如函式和變數,可在會話中立即使用,並維持可用狀態,直到您關閉會話為止。

如同靜態模組,根據預設,動態模組中的 Cmdlet 和函式會匯出,而且變數和別名不是。 不過,您可以使用 Export-ModuleMember Cmdlet 和 new-Module 參數來覆寫預設值。

您也可以使用 New-ModuleAsCustomObject 參數,將動態模組傳回為自定義物件。 模組的成員,例如函式,會實作為自定義物件的腳本方法,而不是匯入會話。

動態模組只存在於記憶體中,而不是存在於磁碟上。 如同所有模組,動態模組的成員會在全域範圍的子系私人模組範圍中執行。 Get-Module 無法取得動態模組,但 Get-Command 可以取得導出的成員。

若要讓動態模組可供 Get-Module使用,請使用管線將 new-Module 命令傳送至 Import-Module,或使用 管線將 new-Module 的模組物件傳回 Import-Module。 此動作會將動態模組新增至 Get-Module 清單,但不會將模組儲存至磁碟或讓它持續運作。

範例

範例 1:建立動態模組

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 的函式的新動態模組。 此命令會傳回代表新動態模組的模組物件。

範例 2:使用動態模組和 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!"

此範例示範 Get-Module Cmdlet 不會傳回動態模組。 其導出的成員會由 get-Command Cmdlet 傳回。

範例 3:將變數匯出至目前的會話

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

此命令會使用 Export-ModuleMember Cmdlet 將變數匯出至目前的會話。 如果沒有 Export-ModuleMember 命令,則只會匯出函式。

輸出顯示變數和函式都已匯出至工作階段。

範例 4:讓動態模組可供 Get-Module

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!"

此命令示範您可以透過將動態模組管線 Import-Module,讓動態模組可供 Get-Module 使用。

第一個命令會使用管線運算符 (|) 將 New-Module 產生的模組 物件傳送至 import-Module Cmdlet 。 此命令會使用 New-ModuleName 參數,將易記名稱指派給模組。 因為 Import-Module 預設不會傳回任何物件,因此此命令沒有輸出。

第二個命令會使用 Get-Module 來取得會話中的模組。 結果顯示 Get-Module 可以取得新的動態模組。

第三個命令會使用 Get-Command Cmdlet 來取得動態模組導出的 Hello 函式。

範例 5:產生具有導出函式的自定義物件

$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

這個範例示範如何使用 New-ModuleAsCustomObject 參數來產生具有表示匯出函式之腳本方法的自定義物件。

第一個命令會使用 New-Module Cmdlet 來產生具有兩個函式 Hello 和 Goodbye 的動態模組。 此命令會使用 AsCustomObject 參數來產生自定義物件,而不是預設 New-Module 產生的 PSModuleInfo 物件。 命令會將自定義物件儲存在 $m 變數中。

第二個命令會嘗試顯示$m變數的值。 沒有內容出現。

第三個命令會使用管線運算符,將自定義對象傳送至 Get-Member Cmdlet,此 Cmdlet 會顯示自定義物件的屬性和方法。 輸出顯示物件具有代表 Hello 和 Goodbye 函式的腳本方法。

第四和第五個命令會使用腳本方法格式來呼叫 Hello 和 Goodbye 函式。

範例 6:取得腳本區塊的結果

New-Module -ScriptBlock {function SayHello {"Hello, World!"}; SayHello} -ReturnResult

Hello, World!

此命令會使用 ReturnResult 參數來要求執行腳本區塊的結果,而不是要求模組物件。

新模組中的腳本區塊會定義SayHello函式,然後呼叫函式。

參數

-ArgumentList

指定自變數陣列,這些自變數是傳遞至腳本區塊的參數值。

類型:Object[]
別名:Args
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-AsCustomObject

指出這個 Cmdlet 會傳回代表動態模組的自定義物件。 模組成員會實作為自定義物件的腳本方法,但不會匯入會話。 您可以將自定義物件儲存在變數中,並使用點表示法來叫用成員。

如果模組有多個具有相同名稱的成員,例如函式和兩個都命名為 A 的變數,則只能從自定義物件存取每個名稱的一個成員。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Cmdlet

指定此 Cmdlet 從模組匯出到目前工作階段的 Cmdlet 陣列。 輸入以逗號分隔的 Cmdlet 清單。 允許通配符。 根據預設,模組中的所有 Cmdlet 都會匯出。

您無法在腳本區塊中定義 Cmdlet,但如果動態模組從二進位模組匯入 Cmdlet,則可以包含 Cmdlet。

類型:String[]
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Function

指定此 Cmdlet 從模組匯出至目前工作階段的函式數位。 輸入以逗號分隔的函式清單。 允許通配符。 根據預設,模組中定義的所有函式都會匯出。

類型:String[]
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:True

-Name

指定新模組的名稱。 您也可以使用管線將模組名稱傳送至 New-Module。

默認值是以 __DynamicModule_ 開頭的自動產生名稱,後面接著指定動態模塊路徑的 GUID。

類型:String
Position:0
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-ReturnResult

表示此 Cmdlet 會執行腳本區塊,並傳回腳本區塊結果,而不是傳回模組物件。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ScriptBlock

指定動態模組的內容。 以大括弧 ({ }) 括住內容,以建立腳本區塊。 這是必要參數。

類型:ScriptBlock
Position:1
預設值:None
必要:True
接受管線輸入:False
接受萬用字元:False

輸入

String

您可以使用管線將模組名稱傳送至此 Cmdlet。

輸出

System.Management.Automation.PSModuleInfo, System.Management.Automation.PSCustomObject, or None

根據預設,此 Cmdlet 會產生 PSModuleInfo 物件。 如果您使用 AsCustomObject 參數,它會產生 PSCustomObject 物件。 如果您使用 ReturnResult 參數,它會傳回評估動態模組中腳本區塊的結果。

備註

  • 您也可以依別名 nmo來參考 New-Module。 如需詳細資訊,請參閱 about_Aliases