Export-ModuleMember

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

Cmdleten Export-ModuleMember anger de modulmedlemmar som exporteras från en skriptmodulfil (.psm1) eller från en dynamisk modul som skapats med hjälp av cmdleten New-Module. Modulmedlemmar omfattar cmdletar, funktioner, variabler och alias. Den här cmdleten kan endast användas i en skriptmodulfil eller en dynamisk modul.

Om en skriptmodul inte innehåller ett Export-ModuleMember kommando exporteras funktionerna och aliasen i skriptmodulen, men variablerna är det inte. När en skriptmodul innehåller Export-ModuleMember kommandon exporteras endast de medlemmar som anges i Export-ModuleMember kommandon. Du kan också använda Export-ModuleMember för att förhindra eller exportera medlemmar som skriptmodulen importerar från andra moduler.

Ett Export-ModuleMember kommando är valfritt, men det är bästa praxis. Även om kommandot bekräftar standardvärdena visar det modulförfattarens avsikt.

Export-ModuleMember -Function * -Alias *

Det här kommandot exporterar alla funktioner och alias som definierats i skriptmodulen.

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

Det här kommandot exporterar tre alias och tre funktioner som definierats i skriptmodulen.

Du kan använda det här kommandoformatet för att ange namnen på modulmedlemmar.

Export-ModuleMember

Det här kommandot anger att inga medlemmar som definierats i skriptmodulen exporteras.

Det här kommandot förhindrar att modulmedlemmarna exporteras, men det döljer inte medlemmarna. Användare kan läsa och kopiera modulmedlemmar eller använda anropsoperatorn (&) för att anropa modulmedlemmar som inte exporteras.

Export-ModuleMember -Variable increment

Det här kommandot exporterar endast variabeln $increment från skriptmodulen. Inga andra medlemmar exporteras.

Om du vill exportera en variabel, förutom att exportera funktionerna i en modul, måste kommandot Export-ModuleMember innehålla namnen på alla funktioner och namnet på variabeln.

# 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

Dessa kommandon visar hur flera Export-ModuleMember kommandon tolkas i en skriptmodulfil (.psm1).

Dessa kommandon skapar tre funktioner och ett alias och exporterar sedan två av funktionerna och aliaset.

Utan de Export-ModuleMember kommandona exporteras alla tre funktionerna och aliaset. Med kommandona Export-ModuleMember exporteras endast funktionerna New-Test och Start-Test och STT alias.

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

Det här kommandot visar hur du använder Export-ModuleMember i en dynamisk modul som skapas med hjälp av cmdleten New-Module.

I det här exemplet används Export-ModuleMember för att exportera både Hi alias och funktionen SayHello i den dynamiska modulen.

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Du kan skicka funktionsnamnsträngar till den här cmdleten.

Den här cmdleten returnerar inga utdata.

• Om du vill exkludera en medlem från listan över exporterade medlemmar lägger du till ett Export-ModuleMember kommando som visar alla andra medlemmar men utelämnar den medlem som du vill exkludera.