Export-ModuleMember
Hiermee geeft u de moduleleden op die worden geëxporteerd.
Syntaxis
Export-ModuleMember
[[-Function] <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[<CommonParameters>]
Description
De Export-ModuleMember
cmdlet geeft de moduleleden op die worden geëxporteerd uit een scriptmodulebestand (.psm1
) of uit een dynamische module die is gemaakt met behulp van de New-Module
cmdlet. Moduleleden omvatten cmdlets, functies, variabelen en aliassen. Deze cmdlet kan alleen worden gebruikt in een scriptmodulebestand of een dynamische module.
Als een scriptmodule geen opdracht bevat Export-ModuleMember
, worden de functies en aliassen in de scriptmodule geëxporteerd, maar de variabelen niet. Wanneer een scriptmodule opdrachten bevat Export-ModuleMember
, worden alleen de leden die zijn opgegeven in de Export-ModuleMember
opdrachten geëxporteerd. U kunt ook leden Export-ModuleMember
onderdrukken of exporteren die de scriptmodule importeert uit andere modules.
Een Export-ModuleMember
opdracht is optioneel, maar het is een best practice. Zelfs als de opdracht de standaardwaarden bevestigt, wordt de bedoeling van de auteur van de module gedemonstreert.
Voorbeelden
Voorbeeld 1: Functies en aliassen exporteren in een scriptmodule
Export-ModuleMember -Function * -Alias *
Met deze opdracht worden alle functies en aliassen geëxporteerd die zijn gedefinieerd in de scriptmodule.
Voorbeeld 2: Specifieke aliassen en functies exporteren
Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt
Met deze opdracht exporteert u drie aliassen en drie functies die zijn gedefinieerd in de scriptmodule.
U kunt deze opdrachtindeling gebruiken om de namen van moduleleden op te geven.
Voorbeeld 3: Geen leden exporteren
Export-ModuleMember
Met deze opdracht geeft u op dat er geen leden die in de scriptmodule zijn gedefinieerd, worden geëxporteerd.
Met deze opdracht voorkomt u dat de moduleleden worden geëxporteerd, maar de leden worden niet verborgen.
Gebruikers kunnen moduleleden lezen en kopiëren of de aanroepoperator (&
) gebruiken om moduleleden aan te roepen die niet worden geëxporteerd.
Voorbeeld 4: Een specifieke variabele exporteren
Export-ModuleMember -Variable increment
Met deze opdracht wordt alleen de $increment
variabele uit de scriptmodule geëxporteerd.
Er worden geen andere leden geëxporteerd.
Als u een variabele wilt exporteren, moet de Export-ModuleMember
opdracht niet alleen de functies in een module exporteren, maar ook de namen van alle functies en de naam van de variabele bevatten.
Voorbeeld 5: Meerdere exportopdrachten
# 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
Deze opdrachten laten zien hoe meerdere Export-ModuleMember
opdrachten worden geïnterpreteerd in een scriptmodulebestand (.psm1
).
Met deze opdrachten maakt u drie functies en één alias en exporteert u vervolgens twee van de functies en de alias.
Zonder de Export-ModuleMember
opdrachten worden alle drie de functies en de alias geëxporteerd. Met de Export-ModuleMember
opdrachten worden alleen de New-Test
en Start-Test
functies en de STT
alias geëxporteerd.
Voorbeeld 6: Leden exporteren in een dynamische module
New-Module -Script {function SayHello {"Hello!"}; Set-Alias Hi SayHello; Export-ModuleMember -Alias Hi -Function SayHello}
Deze opdracht laat zien hoe u deze kunt gebruiken Export-ModuleMember
in een dynamische module die wordt gemaakt met behulp van de New-Module
cmdlet.
In dit voorbeeld Export-ModuleMember
wordt gebruikt om zowel de Hi
alias als de SayHello
functie in de dynamische module te exporteren.
Parameters
-Alias
Hiermee geeft u de aliassen die worden geëxporteerd uit het scriptmodulebestand. Voer de aliasnamen in. Jokertekens zijn toegestaan.
Type: | String[] |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | True |
-Cmdlet
Hiermee geeft u de cmdlets die worden geëxporteerd uit het scriptmodulebestand. Voer de namen van de cmdlets in. Jokertekens zijn toegestaan.
U kunt geen cmdlets maken in een scriptmodulebestand, maar u kunt cmdlets uit een binaire module importeren in een scriptmodule en ze opnieuw exporteren vanuit de scriptmodule.
Type: | String[] |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | True |
-Function
Hiermee geeft u de functies die worden geëxporteerd uit het scriptmodulebestand. Voer de functienamen in.
Jokertekens zijn toegestaan. U kunt ook tekenreeksen voor de functienaam doorsluisen naar Export-ModuleMember
.
Type: | String[] |
Position: | 0 |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | True |
-Variable
Hiermee geeft u de variabelen op die worden geëxporteerd uit het scriptmodulebestand. Voer de namen van de variabelen in, zonder dollarteken ($
). Jokertekens zijn toegestaan.
Type: | String[] |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | True |
Invoerwaarden
U kunt functienaamtekenreeksen naar deze cmdlet doorsluizen.
Uitvoerwaarden
None
Deze cmdlet retourneert geen uitvoer.
Notities
- Als u een lid wilt uitsluiten van de lijst met geëxporteerde leden, voegt u een
Export-ModuleMember
opdracht toe met alle andere leden, maar laat u het lid weg dat u wilt uitsluiten.