Export-ModuleMember

  • Odwołanie
Moduł:
Microsoft.PowerShell.Core

Określa składowe modułu, które są eksportowane.

Składnia

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

Opis

Polecenie Export-ModuleMember cmdlet określa elementy członkowskie modułu wyeksportowane z pliku modułu skryptu (.psm1) lub z modułu dynamicznego utworzonego New-Module przy użyciu polecenia cmdlet . Elementy członkowskie modułu obejmują polecenia cmdlet, funkcje, zmienne i aliasy. To polecenie cmdlet może być używane tylko w pliku modułu skryptu lub module dynamicznym.

Jeśli moduł skryptu nie zawiera Export-ModuleMember polecenia, funkcje i aliasy w module skryptu są eksportowane, ale zmienne nie są. Gdy moduł skryptu zawiera Export-ModuleMember polecenia, eksportowane są tylko elementy członkowskie określone w Export-ModuleMember poleceniach. Można również użyć Export-ModuleMember polecenia , aby pominąć lub wyeksportować elementy członkowskie importujące moduł skryptu z innych modułów.

Polecenie Export-ModuleMember jest opcjonalne, ale jest najlepszym rozwiązaniem. Nawet jeśli polecenie potwierdza wartości domyślne, demonstruje zamiar autora modułu.

Przykłady

Przykład 1. Eksportowanie funkcji i aliasów w module skryptu

Export-ModuleMember -Function * -Alias *

To polecenie eksportuje wszystkie funkcje i aliasy zdefiniowane w module skryptu.

Przykład 2. Eksportowanie określonych aliasów i funkcji

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

To polecenie eksportuje trzy aliasy i trzy funkcje zdefiniowane w module skryptu.

Możesz użyć tego formatu polecenia, aby określić nazwy elementów członkowskich modułu.

Przykład 3. Eksportowanie żadnych elementów członkowskich

Export-ModuleMember

To polecenie określa, że żadne elementy członkowskie zdefiniowane w module skryptu nie są eksportowane.

To polecenie uniemożliwia eksportowanie elementów członkowskich modułu, ale nie ukrywa członków. Użytkownicy mogą odczytywać i kopiować członków modułu lub używać operatora wywołania (&) do wywoływania elementów członkowskich modułu, które nie są eksportowane.

Przykład 4. Eksportowanie określonej zmiennej

Export-ModuleMember -Variable increment

To polecenie eksportuje tylko zmienną $increment z modułu script. Żadne inne elementy członkowskie nie są eksportowane.

Jeśli chcesz wyeksportować zmienną, oprócz eksportowania funkcji w module, Export-ModuleMember polecenie musi zawierać nazwy wszystkich funkcji i nazwę zmiennej.

Przykład 5. Wiele poleceń eksportu

# 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

Te polecenia pokazują, jak wiele Export-ModuleMember poleceń jest interpretowanych w pliku modułu skryptu (.psm1).

Te polecenia tworzą trzy funkcje i jeden alias, a następnie eksportują dwie funkcje i alias.

Export-ModuleMember Bez poleceń wszystkie trzy funkcje i alias zostaną wyeksportowane. Export-ModuleMember Za pomocą poleceń eksportowane są tylko New-Test funkcje i Start-Test oraz STT alias.

Przykład 6. Eksportowanie elementów członkowskich w module dynamicznym

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

To polecenie pokazuje, jak używać Export-ModuleMember w module dynamicznym utworzonym New-Module przy użyciu polecenia cmdlet .

W tym przykładzie Export-ModuleMember jest używany do eksportowania aliasu Hi i SayHello funkcji w module dynamicznym.

Parametry

-Alias

Określa aliasy wyeksportowane z pliku modułu skryptu. Wprowadź nazwy aliasów. Dozwolone są symbole wieloznaczne.

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

-Cmdlet

Określa polecenia cmdlet wyeksportowane z pliku modułu skryptu. Wprowadź nazwy poleceń cmdlet. Dozwolone są symbole wieloznaczne.

Nie można tworzyć poleceń cmdlet w pliku modułu skryptu, ale możesz zaimportować polecenia cmdlet z modułu binarnego do modułu skryptu i ponownie wyeksportować je z modułu skryptu.

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

-Function

Określa funkcje wyeksportowane z pliku modułu skryptu. Wprowadź nazwy funkcji. Dozwolone są symbole wieloznaczne. Możesz również potokować ciągi nazw funkcji do Export-ModuleMember.

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

-Variable

Określa zmienne wyeksportowane z pliku modułu skryptu. Wprowadź nazwy zmiennych bez znaku dolara ($). Dozwolone są symbole wieloznaczne.

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

Dane wejściowe

String

Możesz potokować ciągi nazw funkcji do tego polecenia cmdlet.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.

Uwagi

  • Aby wykluczyć członka z listy wyeksportowanych członków, dodaj Export-ModuleMember polecenie, które wyświetla listę wszystkich innych członków, ale pomija członka, który chcesz wykluczyć.