Export-Alias

Referensi

Modul:: Microsoft.PowerShell.Utility

Mengekspor informasi tentang alias yang saat ini ditentukan ke file.

Sintaks

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

Export-Alias
      -LiteralPath <String>
      [[-Name] <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 menimpa file Alias.csv yang sudah ada, sekalipun 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 Skrip 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.

Jenis:	SwitchParameter
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	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.

Jenis:	ExportAliasFormat
Nilai yang diterima:	Csv, Script
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Jenis:	SwitchParameter
Alias:	cf
Position:	Named
Nilai default:	False
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Description

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

Jenis:	String
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

Menimpa file output, bahkan jika atribut baca-saja diatur 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.

Jenis:	SwitchParameter
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-LiteralPath

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

Jenis:	String
Alias:	PSPath, LP
Position:	Named
Nilai default:	None
Diperlukan:	True
Terima input alur:	True
Terima karakter wildcard:	False

-Name

Menentukan nama sebagai array alias yang akan diekspor. Karakter pengganti diizinkan.

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

Jenis:	String[]
Position:	1
Nilai default:	None
Diperlukan:	False
Terima input alur:	True
Terima karakter wildcard:	True

-NoClobber

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

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 menimpa file dengan atribut baca-saja.

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

Jenis:	SwitchParameter
Alias:	NoOverwrite
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-PassThru

Mengembalikan objek yang mewakili item yang sedang Anda kerjakan. Secara default, cmdlet ini tidak menghasilkan output apa pun.

Jenis:	SwitchParameter
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-Path

Menentukan jalur ke file output. Karakter pengganti diizinkan, tetapi nilai jalur yang dihasilkan harus diarahkan ke satu nama file.

Jenis:	String
Position:	0
Nilai default:	None
Diperlukan:	True
Terima input alur:	False
Terima karakter wildcard:	True

-Scope

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

Global
Local
Script
Angka relatif terhadap cakupan saat ini (0 hingga jumlah cakupan di mana 0 adalah cakupan saat ini dan 1 adalah induknya)

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

Jenis:	String
Position:	Named
Nilai default:	None
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

-WhatIf

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

Jenis:	SwitchParameter
Alias:	wi
Position:	Named
Nilai default:	False
Diperlukan:	False
Terima input alur:	False
Terima karakter wildcard:	False

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output