Export-ModuleMember

  • Référence
Module:
Microsoft.PowerShell.Core

Spécifie les membres de module exportés.

Syntax

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

Description

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

Si un module de script n’inclut pas de Export-ModuleMember commande, les fonctions et les alias du module de script sont exportés, mais les variables ne le sont pas. Lorsqu’un module de script inclut Export-ModuleMember des commandes, seuls les membres spécifiés dans les Export-ModuleMember commandes sont exportés. Vous pouvez également utiliser Export-ModuleMember pour supprimer ou exporter des membres que le module de script importe à partir d’autres modules.

Une Export-ModuleMember commande est facultative, mais c’est une bonne pratique. Même si la commande confirme les valeurs par défaut, elle illustre l'intention de l'auteur du module.

Exemples

Exemple 1 : Exporter des fonctions et des alias dans un module de script

Export-ModuleMember -Function * -Alias *

Cette commande exporte toutes les fonctions et alias définis dans le module de script.

Exemple 2 : Exporter des alias et fonctions spécifiques

Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt

Cette commande exporte trois alias et trois fonctions définies dans le module de script.

Vous pouvez utiliser ce format de commande pour spécifier les noms des membres de module.

Exemple 3 : Exporter aucun membre

Export-ModuleMember

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 du module, mais elle ne masque pas les membres. Les utilisateurs peuvent lire et copier des membres du module ou utiliser l’opérateur d’appel (&) pour appeler des membres de module qui ne sont pas exportés.

Exemple 4 : Exporter une variable spécifique

Export-ModuleMember -Variable increment

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

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

Exemple 5 : Plusieurs commandes d’exportation

# From TestModule.psm1
function New-Test
{
    Write-Output 'I am New-Test function'
}
Export-ModuleMember -Function New-Test

function Validate-Test
{
    Write-Output 'I am Validate-Test function'
}
function Start-Test
{
    Write-Output 'I am Start-Test function'
}
Set-Alias stt Start-Test
Export-ModuleMember -Function Start-Test -Alias stt

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

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

Sans les Export-ModuleMember commandes, les trois fonctions et l’alias sont exportés. Avec les Export-ModuleMember commandes, seules les fonctions et Start-Test l’alias New-TestSTT sont exportées.

Exemple 6 : Exporter des membres dans un module dynamique

New-Module -Script {function SayHello {"Hello!"}; Set-Alias Hi SayHello; Export-ModuleMember -Alias Hi -Function SayHello}

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

Dans cet exemple, Export-ModuleMember il est utilisé pour exporter à la fois l’alias Hi et la SayHello fonction dans le module dynamique.

Paramètres

-Alias

Spécifie les alias qui sont exportés à partir du fichier de module de script. Entrez les noms des alias. Les caractères génériques sont autorisés.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Cmdlet

Spécifie les applets de commande qui sont exportés à partir du fichier de module de script. Entrez les noms des applets de commande. Les caractères génériques sont autorisés.

Vous ne pouvez pas créer des applets de commande dans un fichier de module de script, mais vous pouvez importer les applets de commande à partir d'un module binaire dans un module de script et les exporter de nouveau à partir du module de script.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Function

Spécifie les fonctions exportées à partir du fichier de module de script. Entrez les noms des fonctions. Les caractères génériques sont autorisés. Vous pouvez également diriger des chaînes de nom de fonction vers Export-ModuleMember.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Variable

Spécifie les variables exportées à partir du fichier de module de script. Entrez les noms des variables, sans caractère de signe dollar ($). Les caractères génériques sont autorisés.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

Entrées

String

Vous pouvez diriger des chaînes de nom de fonction vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne pas de sortie.

Notes

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