mercredi 9 novembre 2011

Export-ModuleMember

NOM
    Export-ModuleMember

RÉSUMÉ
    Spécifie les membres de module exportés.

SYNTAXE
    Export-ModuleMember [[-Function] <string[]>] [-Alias <string[]>] [-Cmdlet <string[]>] [-Variable <string[]>] [<CommonParameters>]


DESCRIPTION
    L'applet de commande Export-ModuleMember spécifie les membres de module (tels que les applets de commande, les fonctions, les variables et les alias) exportés à partir d'un fichier de module de script (.psm1) ou d'un module dynamique créé à l'aide de l'applet de commande New-Module. Cette applet de commande peut être uniquement utilisée dans un fichier de module de script ou un module dynamique.

    Si un module de script n'inclut pas de commande Export-ModuleMember, les fonctions du module de script sont exportées, mais pas les variables ni les alias. Lorsqu'un module de script inclut une commande Export-ModuleMember, seuls les membres spécifiés dans la commande Export-ModuleMember sont exportés.

    Si un module de script contient plusieurs commandes Export-ModuleMember, seuls les membres répertoriés dans une commande Export-ModuleMember sont exportés.

    Vous pouvez également utiliser Export-ModuleMember pour exporter des membres que le module de script importe à partir d'autres modules.


PARAMÈTRES
    -Alias <string[]>
        Spécifie les alias qui sont exportés du fichier de module de script. Entrez les noms d'alias. Les caractères génériques sont autorisés.

        Obligatoire ?                false
        Position ?                   named
        Valeur par défaut                     Aucun
        Accepter l'entrée de pipeline ?       true (ByPropertyName)
        Accepter les caractères génériques ?  true

    -Cmdlet <string[]>
        Spécifie les applets de commande exportées du fichier de module de script. Entrez les noms d'applets de commande. Les caractères génériques sont autorisés.

        Vous ne pouvez pas créer d'applets de commande dans un fichier de module de script, mais vous avez la possibilité de les importer à partir d'un module binaire dans un module de script et de les réexporter à partir de ce dernier.

        Obligatoire ?                false
        Position ?                   named
        Valeur par défaut                     Aucun
        Accepter l'entrée de pipeline ?       true (ByPropertyName)
        Accepter les caractères génériques ?  true

    -Function <string[]>
        Spécifie les fonctions exportées du fichier de module de script. Entrez les noms de fonctions. Les caractères génériques sont autorisés. Vous pouvez également diriger des chaînes de noms de fonctions vers Export-ModuleMember.

        Obligatoire ?                false
        Position ?                   1
        Valeur par défaut                     Aucun
        Accepter l'entrée de pipeline ?       true (ByValue, ByPropertyName)
        Accepter les caractères génériques ?  true

    -Variable <string[]>
        Spécifie les variables qui sont exportées du fichier de module de script. Entrez les noms de variables (sans le symbole dollar). Les caractères génériques sont autorisés.

        Obligatoire ?                false
        Position ?                   named
        Valeur par défaut                     Aucun
        Accepter l'entrée de pipeline ?       true (ByPropertyName)
        Accepter les caractères génériques ?  true

    <CommonParameters>
        Cette applet de commande prend en charge les paramètres courants : Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer et OutVariable. Pour plus d'informations, tapez
        « get-help about_commonparameters ».

ENTRÉES
    System.String
        Vous pouvez diriger des chaînes de noms de fonctions vers Export-ModuleMember.


SORTIES
    Aucun
        Cette applet de commande ne génère aucune sortie.


NOTES


        Pour exclure un membre de la liste des membres exportés, ajoutez une commande Export-ModuleMember qui répertorie tous les autres membres, mais omet le membre que vous souhaitez exclure.


    -------------------------- EXEMPLE 1 --------------------------

    C:\PS>Export-ModuleMember -function * -alias *


    Description
    -----------
    Cette commande exporte les alias ainsi que les fonctions définis dans le module de script.

    Pour exporter les alias qui ne sont pas exportés par défaut, vous devez également spécifier explicitement les fonctions. Sinon, seuls les alias seront exportés.





    -------------------------- EXEMPLE 2 --------------------------

    C:\PS>Export-ModuleMember -function Get-Test, New-Test, Start-Test -alias gtt, ntt, stt


    Description
    -----------
    Cette commande exporte trois alias et trois fonctions définis dans le module de script.

    Vous pouvez utiliser ce format de commande pour spécifier les noms des modules de membre.





    -------------------------- EXEMPLE 3 --------------------------

    C:\PS>Export-ModuleMember


    Description
    -----------
    Cette commande spécifie qu'aucun membre défini dans le module de script n'est exporté.

    Cette commande empêche l'exportation des membres de module, mais ne masque pas les membres. Les utilisateurs peuvent lire et copier des membres de module ou employer l'opérateur d'appel (&) pour appeler des membres de module qui ne sont pas exportés.





    -------------------------- EXEMPLE 4 --------------------------

    C:\PS>Export-ModuleMember -variable increment


    Description
    -----------
    Cette commande exporte uniquement la variable $increment du module de script. Aucun autre membre n'est exporté.

    Si vous souhaitez exporter une variable, en plus des fonctions d'un module, la commande Export-ModuleMember doit inclure les noms de toutes les fonctions et le nom de la variable.





    -------------------------- EXEMPLE 5 --------------------------

    C:\PS># From TestModule.psm1

    function new-test
        { <function code> }
    export-modulemember -function new-test

    function validate-test
        { <function code> }

    function start-test
        { <function code> }
    set-alias stt start-test
    export-modulemember -function *-test -alias stt


    Description
    -----------
    Ces commandes montrent comment plusieurs commandes Export-ModuleMember sont interprétées dans un fichier de module de script (.psm1).

    Ces commandes créent trois fonctions et un alias, puis elles exportent deux des fonctions et l'alias.

    Sans les commandes Export-ModuleMember, les trois fonctions seraient exportées, mais pas l'alias. Avec les commandes Export-ModuleMember, seules les fonctions Get-Test et Start-Test et l'alias de technologie STT sont exportés.





    -------------------------- EXEMPLE 6 --------------------------

    C:\PS>new-module -script {function SayHello {"Hello!"}; set-alias Hi SayHello; Export-ModuleMember -alias Hi -function SayHello}


    Description
    -----------
    Cette commande montre comment utiliser Export-ModuleMember dans un module dynamique créé à l'aide de l'applet de commande New-Module.

    Dans cet exemple, Export-ModuleMember est utilisé pour exporter à la fois l'alias « Hi » alias et la fonction « Say Hello » dans le module dynamique.





    -------------------------- EXEMPLE 7 --------------------------

    C:\PS>function export
    {
        param (
            [parameter(mandatory=$true)] [validateset("function","variable")] $type,
            [parameter(mandatory=$true)] $name,
            [parameter(mandatory=$true)] $value
        )
        if ($type -eq "function")
        {
            Set-item "function:script:$name" $value
            Export-ModuleMember $name
        }
        else
        {
            Set-Variable -scope Script $name $value
            Export-ModuleMember -variable $name
        }
    }

    export function New-Test
    {
      ...
    }


    function helper
    {
      ...
    }

    export variable interval 0
    $interval = 2


    Description
    -----------
    Cet exemple inclut une fonction nommée Export qui déclare une fonction ou crée une variable, puis écrit une commande Export-ModuleMember pour la fonction ou la variable. Vous pouvez ainsi déclarer et exporter une fonction ou une variable au moyen d'une seule commande.

    Pour utiliser la fonction Export, incluez-la dans votre module de script. Pour exporter une fonction, tapez « Export » avant le mot clé Function.

    Pour exporter une variable, utilisez le format suivant afin de la déclarer et de définir sa valeur :

        export variable <nom-variable> <valeur>

    Les commandes utilisées dans l'exemple illustrent le format correct. Dans cet exemple, seules la fonction New-Test et la variable $Interval sont exportées.






LIENS CONNEXES
    Online version: http://go.microsoft.com/fwlink/?LinkID=141551
    Import-Module
    Get-Module
    Remove-Module
    about_Modules

Aucun commentaire:

Enregistrer un commentaire