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

L’applet de commande New-Module crée un module dynamique à partir d’un bloc de script. Les membres du module dynamique, tels que les fonctions et les variables, sont immédiatement disponibles dans la session et restent disponibles jusqu’à ce que vous fermez la session.

À l'instar des modules statiques, par défaut, les cmdlets et les fonctions d’un module dynamique sont exportées tandis que les variables et les alias ne le sont pas. Toutefois, vous pouvez utiliser l’applet de commande Export-ModuleMember et les paramètres de New-Module pour remplacer les valeurs par défaut.

Vous pouvez également utiliser le paramètre AsCustomObject de New-Module pour renvoyer le module dynamique en tant qu’objet personnalisé. Les membres des modules, tels que les fonctions, sont implémentés en tant que méthodes de script de l’objet personnalisé au lieu d’être importés dans la session.

Les modules dynamiques existent uniquement en mémoire, et non sur le disque. Comme tous les modules, les membres des modules dynamiques s'exécutent dans une étendue de module privée qui est un enfant de l'étendue globale. Get-Module ne peut pas obtenir un module dynamique, mais Get-Command pouvez obtenir les membres exportés.

Pour rendre un module dynamique disponible pour Get-Module, diriger une commande new-module vers Import-Module ou diriger l’objet de module qui New-Module retourne à import-module. Cette action ajoute le module dynamique à la liste Get-Module , mais elle n’enregistre pas le module sur le disque ou ne le rend pas persistant.

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

Cette commande crée un module dynamique avec une fonction appelée Hello. La commande retourne un objet de module qui représente le nouveau module dynamique.

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

Cet exemple montre que les modules dynamiques ne sont pas retournés par l’applet de commande Get-Module . Les membres qu’ils exportent sont retournés par l’applet de commande Get-Command Get-Command.

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

Cette commande utilise l’applet de commande Export-ModuleMember pour exporter une variable dans la session active. Sans la commande Export-ModuleMember, seule la fonction est exportée.

La sortie indique que la variable et la fonction ont été exportées dans la session.

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

Cette commande montre que vous pouvez rendre un module dynamique disponible pour Get-Module en pipissant le module dynamique vers Import-Module .

La première commande utilise un opérateur de pipeline (|) pour envoyer l’objet de module qui New-Module génère à l’applet de commande Import-Module. La commande utilise le paramètre Name de new-module pour attribuer un nom convivial au module. Étant donné que import-module ne retourne aucun objet par défaut, il n’existe aucune sortie de cette commande.

La deuxième commande utilise Get-Module pour obtenir les modules dans la session. Le résultat montre que Get-Module peut obtenir le nouveau module dynamique.

La troisième commande utilise l’applet de commande Get-Command pour obtenir la fonction Hello que le module dynamique exporte.

$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

Cet exemple montre comment utiliser le paramètre AsCustomObject de new-module pour générer un objet personnalisé qui contient des méthodes de script qui représentent les fonctions exportées.

La première commande utilise l’applet de commande New-Module pour générer un module dynamique avec deux fonctions, Hello et Goodbye. La commande utilise le paramètre AsCustomObject pour générer un objet personnalisé au lieu de l’objet PSModuleInfo généré par défaut New-Module. La commande enregistre l’objet personnalisé dans la variable $m.

La deuxième commande tente d’afficher la valeur de la variable $m. Aucun contenu n’apparaît.

La troisième commande utilise un opérateur de pipeline pour envoyer l’objet personnalisé à l’applet de commande Get-Member, qui affiche les propriétés et méthodes de l’objet personnalisé. La sortie indique que l’objet a des méthodes de script qui représentent les fonctions Hello et Goodbye.

Les quatrième et cinquième commandes utilisent le format de méthode de script pour appeler les fonctions Hello et Goodbye.

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

Hello, World!

Cette commande utilise le paramètre ReturnResult pour demander les résultats de l’exécution du bloc de script au lieu de demander un objet de module.

Le bloc de script dans le nouveau module définit la fonction SayHello, puis appelle la fonction.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Vous pouvez diriger un nom de module vers cette applet de commande.

Cette applet de commande génère par défaut un objet PSModuleInfo. Si vous utilisez le paramètre AsCustomObject, il génère un objet PSCustomObject. Si vous utilisez le paramètre ReturnResult, il retourne le résultat de l’évaluation du bloc de script dans le module dynamique.

• Vous pouvez également faire référence à New-Module par son alias, nmo. Pour plus d’informations, consultez about_Aliases.