Export-Alias

Modul:

Microsoft.PowerShell.Utility Module

Mengekspor informasi tentang alias yang saat ini ditentukan ke file.

Sintaks

ByPath (Default)

Export-Alias
    [-Path] <String>
    [[-Name] <String[]>]
    [-PassThru]
    [-As <ExportAliasFormat>]
    [-Append]
    [-Force]
    [-NoClobber]
    [-Description <String>]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByLiteralPath

Export-Alias
    [[-Name] <String[]>]
    -LiteralPath <String>
    [-PassThru]
    [-As <ExportAliasFormat>]
    [-Append]
    [-Force]
    [-NoClobber]
    [-Description <String>]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

cmdlet Export-Alias mengekspor alias dalam sesi saat ini ke file. Jika file output tidak ada, cmdlet akan membuatnya.

Export-Alias dapat mengekspor alias dalam cakupan tertentu atau semua cakupan, dapat menghasilkan data dalam format CSV atau sebagai serangkaian perintah Set-Alias yang dapat Anda tambahkan ke sesi atau ke profil PowerShell.

Contoh

Contoh 1: Mengekspor alias

Export-Alias -Path "Alias.csv"

Perintah ini mengekspor informasi alias saat ini ke file bernama Alias.csv di direktori saat ini.

Contoh 2: Ekspor alias kecuali jika file ekspor sudah ada

Export-Alias -Path "Alias.csv" -NoClobber

Perintah ini mengekspor alias dalam sesi saat ini ke file Alias.csv.

Karena parameter NoClobber ditentukan, perintah akan gagal jika file Alias.csv sudah ada di direktori saat ini.

Contoh 3: Menambahkan alias ke file

Export-Alias -Path "Alias.csv" -Append -Description "Appended Aliases" -Force

Perintah ini menambahkan alias dalam sesi saat ini ke file Alias.csv.

Perintah menggunakan parameter Deskripsi untuk menambahkan deskripsi ke komentar di bagian atas file.

Perintah ini juga menggunakan parameter Force untuk mengganti file Alias.csv yang sudah ada, bahkan jika memiliki atribut baca-saja.

Contoh 4: Mengekspor alias sebagai skrip

Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $PROFILE -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -FilePath .\alias.ps1

Contoh ini menunjukkan cara menggunakan format file skrip yang Export-Alias hasilkan.

Perintah pertama mengekspor alias dalam sesi ke file Alias.ps1. Ini menggunakan parameter sebagai dengan nilai Script untuk menghasilkan file yang berisi perintah Set-Alias untuk setiap alias.

Perintah kedua menambahkan alias dalam file Alias.ps1 ke profil CurrentUser-CurrentHost. Jalur ke profil disimpan dalam variabel $PROFILE. Perintah menggunakan cmdlet Get-Content untuk mendapatkan alias dari file Alias.ps1 dan cmdlet Add-Content untuk menambahkannya ke profil. Untuk informasi selengkapnya, lihat about_Profiles.

Perintah ketiga dan keempat menambahkan alias dalam file Alias.ps1 ke sesi jarak jauh di komputer Server01. Perintah ketiga menggunakan cmdlet New-PSSession untuk membuat sesi. Perintah keempat menggunakan parameter FilePath cmdlet Invoke-Command untuk menjalankan file Alias.ps1 di sesi baru.

Parameter

-Append

Menunjukkan bahwa cmdlet ini menambahkan output ke file yang ditentukan, alih-alih menimpa konten yang sudah ada dalam file tersebut.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-As

Menetapkan format output. CSV adalah default. Nilai yang dapat diterima untuk parameter ini adalah:

• CSV. Format nilai yang dipisahkan koma (CSV).
• Script. Membuat perintah Set-Alias untuk setiap alias yang diekspor. Jika Anda memberi nama file output dengan ekstensi nama file .ps1, Anda dapat menjalankannya sebagai skrip untuk menambahkan alias ke sesi apa pun.

Properti parameter

Jenis:	ExportAliasFormat
Nilai default:	None
Nilai yang diterima:	Csv, Script
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	Cf

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Description

Menentukan deskripsi file yang diekspor. Deskripsi muncul sebagai komentar di bagian atas file, mengikuti informasi header.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

Menimpa file output, bahkan jika atribut baca-saja diaktifkan pada file.

Secara bawaan, Export-Alias akan menimpa file tanpa memberikan peringatan, kecuali jika atribut baca-saja atau tersembunyi diatur, atau jika parameter NoClobber digunakan dalam perintah. Parameter NoClobber lebih diutamakan daripada parameter Force saat keduanya digunakan dalam perintah.

Parameter Force tidak dapat memaksa Export-Alias menimpa file dengan atribut tersembunyi.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-LiteralPath

Menentukan jalur ke file output. Tidak seperti Jalur, nilai parameter LiteralPath digunakan persis sebagaimana diketik. Tidak ada karakter yang ditafsirkan sebagai wildcard. Jika jalur menyertakan karakter escape, bungkus jalur tersebut dalam tanda kutip tunggal. Tanda kutip tunggal memberi tahu PowerShell untuk tidak menginterpretasikan karakter apa pun sebagai urutan escape.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	PSPath, LP

Set parameter

ByLiteralPath

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

-Name

Menentukan nama sebagai array alias yang akan diekspor. Kartu liar diizinkan.

Secara default, Export-Alias mengekspor semua alias dalam sesi atau cakupan.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	True
DontShow:	False

Set parameter

(All)

Position:	1
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-NoClobber

Menunjukkan bahwa cmdlet ini mencegah Export-Alias menimpa file apa pun, bahkan jika parameter Force digunakan dalam perintah tersebut.

Jika parameter NoClobber dihilangkan, Export-Alias akan menimpa file yang ada tanpa peringatan, kecuali atribut baca-saja diatur pada file. NoClobber lebih diutamakan daripada parameter Force, yang memungkinkan Export-Alias menimpa file dengan atribut hanya-baca.

NoClobber tidak mencegah parameter Append menambahkan konten ke dalam file yang sudah ada.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	NoOverwrite

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-PassThru

Mengembalikan objek yang mewakili item dengan mana Anda bekerja. Secara default, cmdlet ini tidak menghasilkan output apa pun.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Path

Menentukan jalur ke file output. Penggunaan karakter pengganti diizinkan, tetapi nilai jalur yang dihasilkan harus menghasilkan satu nama berkas.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	True
DontShow:	False

Set parameter

ByPath

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

-Scope

Menentukan lingkup dari mana alias harus diekspor. Nilai yang dapat diterima untuk parameter ini adalah:

• Global
• Local
• Script
• Angka yang relatif terhadap cakupan saat ini (mulai dari 0 hingga jumlah cakupan di mana 0 adalah cakupan saat ini dan 1 adalah induk cakupannya)

Nilai defaultnya adalah Local. Untuk informasi selengkapnya, lihat about_Scopes.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	wi

Set parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
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

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Secara default, cmdlet ini tidak mengembalikan output.

AliasInfo

Saat Anda menggunakan parameter PassThru, cmdlet ini mengembalikan objek AliasInfo yang mewakili alias.

Catatan

PowerShell menyertakan alias berikut untuk Export-Alias:

• Semua platform:
  • epal

• Anda hanya dapat melakukan Export-Aliases ke file.

Link Terkait

• Get-Alias
• Import-Alias
• Alias Baru
• Set-Alias