New-Module

Modul:

Microsoft.PowerShell.Core

Erstellt ein neues dynamisches Modul, das nur im Arbeitsspeicher vorhanden ist.

Syntax

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

Beschreibung

Das Cmdlet New-Module erstellt ein dynamisches Modul aus einem Skriptblock. Die Elemente des dynamischen Moduls, z. B. Funktionen und Variablen, sind sofort in der Sitzung verfügbar und bleiben verfügbar, bis Sie die Sitzung schließen.

Wie bei statischen Modulen werden standardmäßig die Cmdlets und Funktionen in einem dynamischen Modul exportiert, während Variablen und Aliase nicht exportiert werden. Sie können jedoch das cmdlet Export-ModuleMember und die Parameter von New-Module verwenden, um die Standardwerte außer Kraft zu setzen.

Sie können auch den AsCustomObject Parameter von New-Module verwenden, um das dynamische Modul als benutzerdefiniertes Objekt zurückzugeben. Die Member der Module, z. B. Funktionen, werden als Skriptmethoden des benutzerdefinierten Objekts implementiert, anstatt in die Sitzung importiert zu werden.

Dynamische Module sind nur im Arbeitsspeicher vorhanden, nicht auf dem Datenträger. Wie bei allen Modulen werden die Elemente von dynamischen Modulen in einem privaten Modulbereich ausgeführt, der ein untergeordnetes Element des globalen Bereichs ist. Get-Module kann kein dynamisches Modul abrufen, aber Get-Command können die exportierten Member abrufen.

Um ein dynamisches Modul für Get-Moduleverfügbar zu machen, führen Sie einen New-Module Befehl an Import-Module weiter, oder führen Sie das Modulobjekt weiter, das New-Module auf Import-Modulezurückgibt. Diese Aktion fügt das dynamische Modul zur Liste Get-Module hinzu, speichert das Modul jedoch nicht auf dem Datenträger oder macht es persistent.

Beispiele

Beispiel 1: Erstellen eines dynamischen Moduls

In diesem Beispiel wird ein neues dynamisches Modul mit einer Funktion namens Helloerstellt. Der Befehl gibt ein Modulobjekt zurück, das das neue dynamische Modul darstellt.

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     : {}

Beispiel 2: Arbeiten mit dynamischen Modulen und Get-Module und Get-Command

In diesem Beispiel wird veranschaulicht, dass dynamische Module nicht vom Cmdlet Get-Module zurückgegeben werden. Die Elemente, die sie exportieren, werden vom Cmdlet Get-Command zurückgegeben.

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

Beispiel 3: Exportieren einer Variablen in die aktuelle Sitzung

In diesem Beispiel wird das Cmdlet Export-ModuleMember verwendet, um eine Variable in die aktuelle Sitzung zu exportieren. Ohne den Befehl Export-ModuleMember wird nur die Funktion exportiert.

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

Die Ausgabe zeigt, dass sowohl die Variable als auch die Funktion in die Sitzung exportiert wurden.

Beispiel 4: Bereitstellen eines dynamischen Moduls für Get-Module

In diesem Beispiel wird veranschaulicht, dass Sie ein dynamisches Modul für Get-Module bereitstellen können, indem Sie das dynamische Modul an Import-Moduleweiterleiten.

New-Module erstellt ein Modulobjekt, das an das Cmdlet Import-Module weitergeleitet wird. Der Name Parameter von New-Module weist dem Modul einen freundlichen Namen zu. Da Import-Module standardmäßig keine Objekte zurückgibt, gibt es keine Ausgabe dieses Befehls. Get-Module, dass das GreetingModule in die aktuelle Sitzung importiert wurde.

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

Das Cmdlet Get-Command zeigt die Hello Funktion an, die vom dynamischen Modul exportiert wird.

Beispiel 5: Generieren eines benutzerdefinierten Objekts mit exportierten Funktionen

In diesem Beispiel wird gezeigt, wie Sie den AsCustomObject Parameter von New-Module verwenden, um ein benutzerdefiniertes Objekt zu generieren, das Skriptmethoden enthält, die die exportierten Funktionen darstellen.

Das cmdlet New-Module erstellt ein dynamisches Modul mit zwei Funktionen, Hello und Goodbye. Der AsCustomObject-Parameter erstellt ein benutzerdefiniertes Objekt anstelle des PSModuleInfo-Objekts, das New-Module standardmäßig generiert. Dieses benutzerdefinierte Objekt wird in der variablen $m gespeichert. Die variable $m scheint keinen zugewiesenen Wert zu haben.

$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

Die Übergabe von $m an das Cmdlet Get-Member zeigt die Eigenschaften und Methoden des benutzerdefinierten Objekts an. Die Ausgabe zeigt, dass das Objekt Skriptmethoden enthält, die die funktionen Hello und Goodbye darstellen. Schließlich rufen wir diese Skriptmethoden auf und zeigen die Ergebnisse an.

Beispiel 6: Abrufen der Ergebnisse des Skriptblocks

In diesem Beispiel wird der parameter ReturnResult verwendet, um die Ergebnisse der Ausführung des Skriptblocks anzufordern, anstatt ein Modulobjekt anzufordern. Der Skriptblock im neuen Modul definiert die SayHello-Funktion und ruft dann die Funktion auf.

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

Hello, World!

Parameter

-ArgumentList

Gibt ein Array von Argumenten an, die Parameterwerte sind, die an den Skriptblock übergeben werden. Weitere Informationen zum Verhalten von ArgumentListfinden Sie unter about_Splatting.

Typ:	Object[]
Aliase:	Args
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-AsCustomObject

Gibt an, dass dieses Cmdlet ein benutzerdefiniertes Objekt zurückgibt, das das dynamische Modul darstellt. Die Modulmitglieder werden als Skriptmethoden des benutzerdefinierten Objekts implementiert, jedoch nicht in die Sitzung importiert. Sie können das benutzerdefinierte Objekt in einer Variablen speichern und die Elemente mithilfe der Punktnotation aufrufen.

Wenn das Modul mehrere Elemente mit demselben Namen aufweist, z. B. eine Funktion und eine Variable mit dem Namen A, kann nur ein Element mit jedem Namen über das benutzerdefinierte Objekt zugegriffen werden.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Cmdlet

Gibt ein Array von Cmdlets an, die von diesem Cmdlet aus dem Modul in die aktuelle Sitzung exportiert werden. Geben Sie eine durch Trennzeichen getrennte Liste von Cmdlets ein. Platzhalterzeichen sind zulässig. Standardmäßig werden alle Cmdlets im Modul exportiert.

Sie können keine Cmdlets in einem Skriptblock definieren, aber ein dynamisches Modul kann Cmdlets enthalten, wenn sie die Cmdlets aus einem binären Modul importiert.

Typ:	String[]
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Function

Gibt eine Reihe von Funktionen an, die dieses Cmdlet aus dem Modul in die aktuelle Sitzung exportiert. Geben Sie eine durch Trennzeichen getrennte Liste von Funktionen ein. Platzhalterzeichen sind zulässig. Standardmäßig werden alle in einem Modul definierten Funktionen exportiert.

Typ:	String[]
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-Name

Gibt einen Namen für das neue Modul an. Sie können auch einen Modulnamen an New-Module übergeben.

Der Standardwert ist ein automatisch generierter Name, der mit __DynamicModule_ beginnt und auf eine GUID folgt, die den Pfad des dynamischen Moduls angibt.

Typ:	String
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ReturnResult

Gibt an, dass dieses Cmdlet den Skriptblock ausführt und die Skriptblockergebnisse zurückgibt, anstatt ein Modulobjekt zurückzugeben.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-ScriptBlock

Gibt den Inhalt des dynamischen Moduls an. Schließen Sie den Inhalt in geschweifte Klammern ({}) ein, um einen Skriptblock zu erstellen. Dieser Parameter ist erforderlich.

Typ:	ScriptBlock
Position:	1
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

String

Sie können einen Modulnamen an dieses Cmdlet weiterleiten.

Ausgaben

PSModuleInfo

Dieses Cmdlet generiert standardmäßig ein PSModuleInfo--Objekt.

PSCustomObject

Wenn Sie den AsCustomObject Parameter verwenden, wird ein PSCustomObject--Objekt generiert.

Object

Wenn Sie den parameter ReturnResult verwenden, gibt dieses Cmdlet das Ergebnis der Auswertung des Skriptblocks im dynamischen Modul zurück.

Hinweise

PowerShell enthält die folgenden Aliase für New-Module:

• Alle Plattformen:
  • nmo

Ähnliche Themen

• Export-ModuleMember
• Get-Module
• Import-Module
• Remove-Module