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

Export-Alias Cmdlet 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 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 ada, bahkan jika mereka 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 dihasilkan.

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 $Profile variabel. Perintah menggunakan Get-Content cmdlet untuk mendapatkan alias dari file Alias.ps1 dan Add-Content cmdlet 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 New-PSSession cmdlet 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, daripada menimpa konten yang ada dari file tersebut.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-As

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

  • CSV. Format nilai yang dipisahkan koma (CSV).
  • Skrip. Set-Alias Membuat perintah 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.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.

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

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

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LiteralPath

Menentukan jalur ke file output. Tidak seperti Path, nilai parameter LiteralPath digunakan persis seperti yang ditik. Tidak ada karakter yang ditafsirkan sebagai kartubebas. 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.

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Menentukan nama sebagai array alias yang akan diekspor. Kartubebas diizinkan.

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

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-NoClobber

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

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

NoClobber tidak mencegah parameter Tambahkan menambahkan konten ke file yang ada.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Menentukan jalur ke file output. Kartubebas diizinkan, tetapi nilai jalur yang dihasilkan harus diselesaikan ke satu nama file.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Scope

Menentukan cakupan tempat alias harus diekspor. Nilai yang dapat diterima untuk parameter ini adalah:

  • Global
  • Lokal
  • Skrip
  • Angka relatif terhadap cakupan saat ini (0 melalui jumlah cakupan di mana 0 adalah cakupan saat ini dan 1 adalah induknya)

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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 Mengekspor-Alias ke file.