Export-ModuleMember
Określa składowe modułu, które są eksportowane.
Składnia
Default (Domyślna)
Export-ModuleMember
[[-Function] <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[<CommonParameters>]
Opis
Polecenie cmdlet Export-ModuleMember określa elementy członkowskie modułu wyeksportowane z pliku modułu skryptu (.psm1) lub z modułu dynamicznego utworzonego przy użyciu polecenia cmdlet New-Module. 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 polecenia Export-ModuleMember, funkcje i aliasy w module skryptu są eksportowane, ale zmienne nie są. Gdy moduł skryptu zawiera polecenia Export-ModuleMember, eksportowane są tylko elementy członkowskie określone w Export-ModuleMember poleceniach. Można również użyć Export-ModuleMember do pomijania lub eksportowania elementów członkowskich importowanych przez moduł skryptu z innych modułów.
Polecenie Export-ModuleMember jest opcjonalne, ale jest to najlepsze rozwiązanie. 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, polecenie Export-ModuleMember 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 poleceń Export-ModuleMember jest interpretowanych w pliku skryptu (.psm1).
Te polecenia tworzą trzy funkcje i jeden alias, a następnie eksportują dwie funkcje i alias.
Bez Export-ModuleMember poleceń wszystkie trzy funkcje i alias zostaną wyeksportowane. Za pomocą poleceń Export-ModuleMember eksportowane są tylko funkcje New-Test i Start-Test oraz alias STT.
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 przy użyciu polecenia cmdlet New-Module.
W tym przykładzie Export-ModuleMember służy do eksportowania aliasu Hi i funkcji SayHello w module dynamicznym.
Parametry
-Alias
Określa aliasy wyeksportowane z pliku modułu skryptu. Wprowadź nazwy aliasów. Symbole wieloznaczne są dozwolone.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-Cmdlet
Określa polecenia cmdlet wyeksportowane z pliku modułu skryptu. Wprowadź nazwy poleceń cmdlet. Symbole wieloznaczne są dozwolone.
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.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-Function
Określa funkcje wyeksportowane z pliku modułu skryptu. Wprowadź nazwy funkcji.
Symbole wieloznaczne są dozwolone. Możesz również potokować ciągi nazw funkcji, aby Export-ModuleMember.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | 0 |
| Obowiązkowy: | False |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-Variable
Określa zmienne wyeksportowane z pliku modułu skryptu. Wprowadź nazwy zmiennych bez znaku dolara ($). Symbole wieloznaczne są dozwolone.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
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 elementów członkowskich, dodaj polecenie
Export-ModuleMember, które wyświetla listę wszystkich innych elementów członkowskich, ale pomija element członkowski, który chcesz wykluczyć.
