Import-Module

Import-Module [-Name] <string[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]

Import-Module [-Assembly] <Assembly[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]

Import-Module [-ModuleInfo] <PSModuleInfo[]> [-Alias <string[]>] [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Force] [-Function <string[]>] [-Global] [-PassThru] [-Prefix <string>] [-Variable <string[]>] [-Version <Version>] [<CommonParameters>]

C:\PS>import-module -name BitsTransfer

Beschreibung
-----------
Mit diesem Befehl werden die Elemente des BitsTransfer-Moduls in die aktuelle Sitzung importiert.

Die Angabe des Name-Parameters (-Name) ist optional.

Standardmäßig wird von Import-Module beim Importieren eines Moduls keine Ausgabe generiert. Fordern Sie die Ausgabe mit dem PassThru-Parameter oder AsCustomObject-Parameter oder mit dem allgemeinen Verbose-Parameter an.

C:\PS>get-module -listAvailable | import-module

Beschreibung
-----------
Mit diesem Befehl werden alle verfügbaren Module in dem Pfad, der von der PSModulePath-Umgebungsvariablen ("$env:psmodulepath") angegebenen wird, in die aktuelle Sitzung importiert.

C:\PS>$m = get-module -ListAvailable BitsTransfer, ServerBackup

C:\PS> import-module -moduleInfo $m

Beschreibung
-----------
Mit diesen Befehlen werden die Elemente des BitsTransfer-Moduls und des ServerBackup-Moduls in die aktuelle Sitzung importiert. 

Im ersten Befehl werden mit dem Cmdlet "Get-Module" die PSModuleInfo-Objekte abgerufen, die das BitsTransfer-Modul und das ServerBackup-Modul darstellen. Die Objekte werden in der Variablen "$m" gespeichert. Beim Abrufen von Modulen, die noch nicht in die Sitzung importiert werden, ist der ListAvailable-Parameter erforderlich.

Im zweiten Befehl werden die Module mit dem ModuleInfo-Parameter von Import-Module in die aktuelle Sitzung importiert. 

Diese Befehle entsprechen der Verwendung eines Pipelineoperators (|) zum Senden der Ausgabe eines Get-Module-Befehls an Import-Module.

C:\PS>import-module -name c:\ps-test\modules\test -verbose

VERBOSE: Loading module from path 'C:\ps-test\modules\Test\Test.psm1'.
VERBOSE: Exporting function 'my-parm'.
VERBOSE: Exporting function 'get-parm'.
VERBOSE: Exporting function 'get-spec'.
VERBOSE: Exporting function 'get-specDetails'.

Beschreibung
-----------
Dieser Befehl verwendet einen expliziten Pfad, um das Modul zu identifizieren, das importiert werden soll. 

Außerdem wird mit dem allgemeinen Verbose-Parameter eine Liste der aus dem Modul importierten Elemente abgerufen. Ohne die Parameter "Verbose", "PassThru" oder "AsCustomObject" wird von Import-Module beim Importieren eines Moduls keine Ausgabe generiert.

C:\PS>import-module BitsTransfer -cmdlet Add-BitsTransferFile, Get-BitsTransfer

C:\PS> get-module BitsTransfer

Name              : BitsTransfer
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer\BitsTransfer.psd1
Description       :
Guid              : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version           : 1.0.0.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {[Add-BitsTransfer, Add-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer], [Get-BitsTransfer, Get-BitsTransfer], [Rem
                    ove-BitsTransfer, Remove-BitsTransfer]...}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {Microsoft.BackgroundIntelligentTransfer.Management}


C:\PS> get-command -module BitsTransfer

CommandType Name                Definition
----------- ----                ----------
Cmdlet      Add-BitsTransfer    Add-BitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> [[-Destination] <String[]>] [-Verbose] [-Debug] [-ErrorA...
Cmdlet      Get-BitsTransfer    Get-BitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningActi...

Beschreibung
-----------
In diesem Beispiel wird verdeutlicht, wie die in die Sitzung importierten Modulelemente eingeschränkt werden und wie sich dieser Befehl auf die Sitzung auswirkt. 

Mit dem ersten Befehl werden nur die Cmdlets "Add-BitsTransfer" und "Get-BitsTransfer" aus dem BitsTransfer-Modul importiert. Der Befehl verwendet den Cmdlet-Parameter, um die vom Modul importierten Cmdlets einzuschränken. Sie können auch den Parameter "Alias", "Variable" und "Function" verwenden, um weitere von einem Modul importierte Elemente einzuschränken.

Der zweite Befehl verwendet das Cmdlet "Get-Module", um das Objekt abzurufen, das das BitsTransfer-Modul darstellt. Die ExportedCmdlets-Eigenschaft listet alle vom Modul exportierten Cmdlets auf, auch wenn sie nicht alle importiert wurden.

Der dritte Befehl ruft die Befehle, die aus dem BitsTransfer-Modul importiert wurden, mithilfe des Module-Parameters des Cmdlets "Get-Command" ab. Die Ergebnisse zeigen, dass nur die Cmdlets "Add-BitsTransfer" und "Get-BitsTransfer" importiert wurden.

C:\PS>import-module BitsTransfer -prefix PS -passthru

Name              : bitstransfer
Path              : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer\bitstransfer.psd1
Description       :
Guid              : 8fa5064b-8479-4c5c-86ea-0d311fe48875
Version           : 1.0.0.0
ModuleBase        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\bitstransfer
ModuleType        : Manifest
PrivateData       :
AccessMode        : ReadWrite
ExportedAliases   : {}
ExportedCmdlets   : {[Add-BitsTransfer, Add-BitsTransfer], [Remove-BitsTransfer, Remove-BitsTransfer], [Complete-BitsTransfer, Complete-BitsTransfer]
                    , [Get-BitsTransfer, Get-BitsTransfer]...}
ExportedFunctions : {}
ExportedVariables : {}
NestedModules     : {Microsoft.BackgroundIntelligentTransfer.Management}


C:\PS> get-command -module bitstransfer

CommandType     Name                        Definition
-----------     ----                        ----------
Cmdlet          Add-PSBitsTransfer          Add-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Source] <String[]> ...
Cmdlet          Complete-PSBitsTransfer     Complete-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Deb...
Cmdlet          Get-PSBitsTransfer          Get-PSBitsTransfer [[-Name] <String[]>] [-AllUsers] [-Verbose] ...
Cmdlet          Remove-PSBitsTransfer       Remove-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debug...
Cmdlet          Resume-PSBitsTransfer       Resume-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Asynchronous] [-...
Cmdlet          Set-PSBitsTransfer          Set-PSBitsTransfer [-BitsJob] <BitsJob[]> [-DisplayName <String...
Cmdlet          Start-PSBitsTransfer        Start-PSBitsTransfer [[-Source] <String[]>] [[-Destination] <St...
Cmdlet          Suspend-PSBitsTransfer      Suspend-PSBitsTransfer [-BitsJob] <BitsJob[]> [-Verbose] [-Debu...

Beschreibung
-----------
Mit diesen Befehlen wird das BitsTransfer-Modul in die aktuelle Sitzung importiert, den Elementnamen wird ein Präfix vorangestellt, und die Elementnamen mit Präfix werden angezeigt. 

Im ersten Befehl wird mit dem Cmdlet "Import-Module" das BitsTransfer-Modul importiert. Mit dem Prefix-Parameter wird das Präfix "PS" allen Elementen hinzugefügt, die aus dem Modul importiert werden, und mit dem PassThru-Parameter wird ein Modulobjekt zurückzugeben, das das importierte Modul darstellt.

Das Modulobjekt, das vom Befehl zurückgegeben wird, verfügt über eine ExportedCmdlets-Eigenschaft, mit der die exportierten Elemente aufgelistet werden. Das Präfix wird nicht in den Cmdlet-Namen angezeigt, da es nach dem Exportieren der Elemente, jedoch vor dem Importieren angewendet wird.

Im zweiten Befehl werden mit dem Cmdlet "Get-Command" die Elemente abgerufen, die aus dem Modul importiert wurden. Das Modul wird mit dem Module-Parameter angegeben. Die Ausgabe zeigt, dass die Modulelemente ordnungsgemäß mit einem Präfix versehen wurden.

Das verwendete Präfix gilt nur für die Elemente in der aktuellen Sitzung. Das Modul wird nicht geändert.

C:\PS>get-module -list | format-table -property name, moduletype -auto

Name          ModuleType
----          ----------
Show-Calendar     Script
BitsTransfer    Manifest
PSDiagnostics   Manifest
TestCmdlets       Script

C:\PS> $a = import-module -name Show-Calendar -asCustomObject

C:\PS> $a | 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()
Show-Calendar ScriptMethod System.Object Show-Calendar();

C:\PS> $a."show-calendar"()

Beschreibung
-----------
Diese Befehle veranschaulichen, wie das benutzerdefinierte Objekt, das von Import-Module zurückgegeben wird, abgerufen und verwendet wird. 

Benutzerdefinierte Objekte enthalten synthetische Elemente, die die einzelnen importierten Modulelemente darstellen. Beispielsweise werden die Cmdlets und Funktionen in einem Modul in Skriptmethoden des benutzerdefinierten Objekts konvertiert.

Benutzerdefinierte Objekte sind sehr hilfreich für die Skripterstellung. Sie sind außerdem hilfreich, wenn mehrere importierte Objekte den gleichen Namen haben. Die Verwendung der Skriptmethode eines Objekts entspricht dem Angeben des vollqualifizierten Namens eines importierten Elements einschließlich des Modulnamens.

Der AsCustomObject-Parameter kann nur mit einem Skriptmodul verwendet werden. Daher muss zunächst bestimmt werden, welches verfügbare Modul ein Skriptmodul darstellt.

Im ersten Befehl werden mit dem Cmdlet "Get-Module" die verfügbaren Module abgerufen. Im Befehl werden die Modulobjekte mit einem Pipelineoperator (|) an das Cmdlet "Format-Table" übergeben, das den Namen sowie den ModuleType der einzelnen Module in einer Tabelle auflistet.

Im zweiten Befehl wird mit dem Cmdlet "Import-Module" das Skriptmodul "Show-Calendar" importiert. Der Befehl fordert mit dem AsCustomObject-Parameter ein benutzerdefiniertes Objekt an. Mit dem Befehl wird das resultierende benutzerdefinierte Objekt in der Variablen "$a" gespeichert.

Im dritten Befehl wird die Variable "$a" mit einem Pipelineoperator an das Cmdlet "Get-Member" gesendet, und die Eigenschaften und Methoden von PSCustomObject in "$a" werden abgerufen. In der Ausgabe wird die Skriptmethode "Show-Calendar" angezeigt.

Im letzten Befehl wird die Skriptmethode "Show-Calendar" verwendet. Der Methodenname muss in Anführungszeichen eingeschlossen werden, da er einen Bindestrich enthält.

C:\PS>import-module BitsTransfer

C:\PS> import-module BitsTransfer -force -prefix PS

Beschreibung
-----------
In diesem Beispiel wird gezeigt, wie der Force-Parameter von Import-Module verwendet wird, wenn Sie ein Modul erneut in die gleiche Sitzung importieren. 

Mit dem ersten Befehl wird das BitsTransfer-Modul importiert. Im zweiten Befehl wird das Modul erneut importiert, dieses Mal mit dem Prefix-Parameter. 

Der zweite Befehl schließt auch den Force-Parameter ein, der das Modul entfernt und es dann erneut importiert. Ohne Angabe dieses Parameters würde die Sitzung zwei Versionen des Cmdlets "BitsTransfer" enthalten, eine mit dem Standardnamen und eine mit dem Namen, dem ein Präfix vorangestellt ist.

C:\PS>get-date

Saturday, September 12, 2009 6:47:04 PM

C:\PS> import-module TestModule

C:\PS> get-date
09255

C:\PS> get-command get-date | format-table -property commandtype, name, pssnapin, module -auto

CommandType  Name       pssnapin                       Module
-----------  ----       --------                       ------
   Function  Get-Date                                  TestModule
     Cmdlet  Get-Date   Microsoft.PowerShell.Utility


C:\PS> Microsoft.PowerShell.Utility\get-date

Saturday, September 12, 2009 6:33:23 PM

Beschreibung
-----------
In diesem Beispiel wird gezeigt, wie Befehle, die von importierten Befehlen ausgeblendet wurden, ausgeführt werden.

Der erste Befehl führt das Cmdlet "Get-Date" aus, das mit Windows PowerShell ausgeliefert wird. Er gibt ein DateTime-Objekt mit dem aktuellen Datum zurück.

Mit dem zweiten Befehl wird das Modul "TestModule" importiert. Dieses Modul schließt eine Funktion mit dem Namen Get-Date ein, die das julianische Datum zurückgibt. 

Mit dem dritten Befehl wird der Befehl "Get-Date" erneut ausgeführt. Da Funktionen Vorrang gegenüber Cmdlets haben, wurde anstelle des Cmdlets "Get-Date" die Get-Date-Funktion aus dem Modul "TestModule" ausgeführt.

Der vierte Befehl zeigt, dass zwei Get-Date-Befehle in der Sitzung vorhanden sind, eine Funktion aus dem Modul "TestModule" und ein Cmdlet aus dem Microsoft.PowerShell.Utility-Snap-In.

Der fünfte Befehl führt das ausgeblendete Cmdlet aus, indem er den Befehlsnamen mit dem Snap-In-Namen qualifiziert. 

Weitere Informationen zur Befehlsrangfolge in Windows PowerShell finden Sie unter "about_command_precedence".