Bagikan melalui

Export-ModuleMember

Modul:
Microsoft.PowerShell.Core Module

Menentukan anggota modul yang diekspor.

Sintaks

Default (Default) 

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

Deskripsi

cmdlet Export-ModuleMember menentukan anggota modul yang diekspor dari file modul skrip (.psm1), atau dari modul dinamis yang dibuat dengan menggunakan cmdlet New-Module. 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 perintah Export-ModuleMember, fungsi dan alias dalam modul skrip diekspor, tetapi variabelnya tidak. Saat modul skrip menyertakan perintah Export-ModuleMember, hanya anggota yang ditentukan dalam perintah Export-ModuleMember 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 mengekspor variabel $increment dari modul skrip. Tidak ada anggota lain yang diekspor.

Jika Anda ingin mengekspor variabel, selain mengekspor fungsi dalam modul, perintah Export-ModuleMember 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 perintah Export-ModuleMember ditafsirkan dalam file modul skrip (.psm1).

Perintah ini membuat tiga fungsi dan satu alias, dan kemudian mengekspor dua fungsi dan alias.

Tanpa perintah Export-ModuleMember, ketiga fungsi dan alias akan diekspor. Dengan perintah Export-ModuleMember, hanya fungsi New-Test dan Start-Test dan alias STT 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 cmdlet New-Module.

Dalam contoh ini, Export-ModuleMember digunakan untuk mengekspor alias Hi dan fungsi SayHello dalam modul dinamis.

Parameter

-Alias

Menentukan alias yang diekspor dari file modul skrip. Masukkan nama alias. Karakter pengganti diizinkan.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Cmdlet

Menentukan cmdlet yang diekspor dari file modul skrip. Masukkan nama cmdlet. Karakter pengganti 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.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Function

Menentukan fungsi yang diekspor dari file modul skrip. Masukkan nama fungsi. Karakter pengganti diizinkan. Anda juga dapat menyalurkan string nama fungsi ke Export-ModuleMember.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:0
Wajib:False
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Variable

Menentukan variabel yang diekspor dari file modul skrip. Masukkan nama variabel, tanpa karakter tanda dolar ($). Karakter pengganti diizinkan.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

String

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 Export-ModuleMember yang mencantumkan semua anggota lain tetapi menghilangkan anggota yang ingin Anda kecualikan.