Export-ModuleMember
Hiermee geeft u de moduleleden op die worden geëxporteerd.
Syntax
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 geëxporteerd die in de Export-ModuleMember
opdrachten zijn opgegeven. U kunt ook gebruiken Export-ModuleMember
om leden te onderdrukken of te exporteren die door de scriptmodule uit andere modules worden geïmporteerd.
Een Export-ModuleMember
opdracht is optioneel, maar het is een best practice. Zelfs als de opdracht de standaardwaarden bevestigt, wordt de intentie van de auteur van de module weergegeven.
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 in de scriptmodule zijn gedefinieerd.
Voorbeeld 2: specifieke aliassen en functies exporteren
Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt
Met deze opdracht worden drie aliassen en drie functies geëxporteerd 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 worden geëxporteerd die zijn gedefinieerd in de scriptmodule.
Met deze opdracht voorkomt u dat de moduleleden worden geëxporteerd, maar worden de leden niet verborgen.
Gebruikers kunnen moduleleden lezen en kopiëren of de aanroepoperator (&
) gebruiken om moduleleden aan te roepen die niet zijn geëxporteerd.
Voorbeeld 4: Een specifieke variabele exporteren
Export-ModuleMember -Variable increment
Met deze opdracht exporteert alleen de $increment
variabele uit de scriptmodule.
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 worden drie functies en één alias gemaakt, waarna twee van de functies en de alias worden geëxporteerd.
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
functies en Start-Test
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 kunt gebruiken Export-ModuleMember
in een dynamische module die is 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 op die worden geëxporteerd uit het scriptmodulebestand. Voer de aliasnamen in. Jokertekens zijn toegestaan.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Cmdlet
Hiermee geeft u de cmdlets op 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 deze opnieuw exporteren vanuit de scriptmodule.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Function
Hiermee geeft u de functies die worden geëxporteerd uit het scriptmodulebestand. Voer de functienamen in.
Jokertekens zijn toegestaan. U kunt functienaamtekenreeksen ook doorsluizen naar Export-ModuleMember
.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Variable
Hiermee geeft u de variabelen op die worden geëxporteerd uit het scriptmodulebestand. Voer de namen van de variabelen in, zonder een dollarteken ($
). Jokertekens zijn toegestaan.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Invoerwaarden
U kunt functienaamtekenreeksen doorsluizen naar deze cmdlet.
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 waarmee alle andere leden worden vermeld, maar het lid dat u wilt uitsluiten, weglaat.