Export-ModuleMember
Menentukan anggota modul yang diekspor.
Sintaks
Export-ModuleMember
[[-Function] <String[]>]
[-Cmdlet <String[]>]
[-Variable <String[]>]
[-Alias <String[]>]
[<CommonParameters>]
Deskripsi
Export-ModuleMember
Cmdlet menentukan anggota modul yang diekspor dari file modul skrip (.psm1
), atau dari modul dinamis yang dibuat dengan menggunakan New-Module
cmdlet. Anggota modul mencakup cmdlet, fungsi, variabel, dan alias. Cmdlet ini hanya dapat digunakan dalam file modul skrip atau modul dinamis.
Jika modul skrip tidak menyertakan Export-ModuleMember
perintah, fungsi dan alias dalam modul skrip diekspor, tetapi variabelnya tidak. Saat modul skrip menyertakan Export-ModuleMember
perintah, hanya anggota yang ditentukan dalam Export-ModuleMember
perintah yang diekspor. Anda juga dapat menggunakan Export-ModuleMember
untuk menekan atau mengekspor anggota yang diimpor modul skrip dari modul lain.
Perintah Export-ModuleMember
bersifat opsional, tetapi ini adalah praktik terbaik. Bahkan jika perintah mengonfirmasi nilai default, perintah menunjukkan niat penulis modul.
Contoh
Contoh 1: Mengekspor fungsi dan alias dalam modul skrip
Export-ModuleMember -Function * -Alias *
Perintah ini mengekspor semua fungsi dan alias yang ditentukan dalam modul skrip.
Contoh 2: Mengekspor alias dan fungsi tertentu
Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt
Perintah ini mengekspor tiga alias dan tiga fungsi yang ditentukan dalam modul skrip.
Anda dapat menggunakan format perintah ini untuk menentukan nama anggota modul.
Contoh 3: Ekspor tanpa anggota
Export-ModuleMember
Perintah ini menentukan bahwa tidak ada anggota yang ditentukan dalam modul skrip yang diekspor.
Perintah ini mencegah anggota modul diekspor, tetapi tidak menyembunyikan anggota.
Pengguna dapat membaca dan menyalin anggota modul atau menggunakan operator panggilan (&
) untuk memanggil anggota modul yang tidak diekspor.
Contoh 4: Mengekspor variabel tertentu
Export-ModuleMember -Variable increment
Perintah ini hanya $increment
mengekspor variabel dari modul skrip.
Tidak ada anggota lain yang diekspor.
Jika Anda ingin mengekspor variabel, selain mengekspor fungsi dalam modul, Export-ModuleMember
perintah harus menyertakan nama semua fungsi dan nama variabel.
Contoh 5: Beberapa perintah ekspor
# 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
Perintah ini menunjukkan bagaimana beberapa Export-ModuleMember
perintah ditafsirkan dalam file modul skrip (.psm1
).
Perintah ini membuat tiga fungsi dan satu alias, dan kemudian mengekspor dua fungsi dan alias.
Export-ModuleMember
Tanpa perintah, ketiga fungsi dan alias akan diekspor. Export-ModuleMember
Dengan perintah, hanya New-Test
fungsi dan Start-Test
dan STT
alias yang diekspor.
Contoh 6: Mengekspor anggota dalam modul dinamis
New-Module -Script {function SayHello {"Hello!"}; Set-Alias Hi SayHello; Export-ModuleMember -Alias Hi -Function SayHello}
Perintah ini menunjukkan cara menggunakan Export-ModuleMember
dalam modul dinamis yang dibuat dengan menggunakan New-Module
cmdlet.
Dalam contoh ini, Export-ModuleMember
digunakan untuk mengekspor Hi
alias dan SayHello
fungsi dalam modul dinamis.
Parameter
-Alias
Menentukan alias yang diekspor dari file modul skrip. Masukkan nama alias. Karakter kartubebas diizinkan.
Jenis: | String[] |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | True |
-Cmdlet
Menentukan cmdlet yang diekspor dari file modul skrip. Masukkan nama cmdlet. Karakter kartubebas diizinkan.
Anda tidak dapat membuat cmdlet dalam file modul skrip, tetapi Anda dapat mengimpor cmdlet dari modul biner ke dalam modul skrip dan mengekspornya kembali dari modul skrip.
Jenis: | String[] |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | True |
-Function
Menentukan fungsi yang diekspor dari file modul skrip. Masukkan nama fungsi.
Karakter kartubebas diizinkan. Anda juga dapat menyalurkan string nama fungsi ke Export-ModuleMember
.
Jenis: | String[] |
Position: | 0 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | True |
-Variable
Menentukan variabel yang diekspor dari file modul skrip. Masukkan nama variabel, tanpa karakter tanda dolar ($
). Karakter kartubebas diizinkan.
Jenis: | String[] |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | True |
Input
Anda dapat menyalurkan string nama fungsi ke cmdlet ini.
Output
None
Cmdlet ini tidak mengembalikan output.
Catatan
- Untuk mengecualikan anggota dari daftar anggota yang diekspor, tambahkan perintah yang mencantumkan
Export-ModuleMember
semua anggota lain tetapi menghilangkan anggota yang ingin Anda kecualikan.