Set-Alias

  • Referensi
Modul:
Microsoft.PowerShell.Utility

Membuat atau mengubah alias untuk cmdlet atau perintah lain dalam sesi PowerShell saat ini.

Sintaks

Set-Alias
   [-Name] <string>
   [-Value] <string>
   [-Description <string>]
   [-Option <ScopedItemOptions>]
   [-PassThru]
   [-Scope <string>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Deskripsi

Set-Alias Cmdlet membuat atau mengubah alias untuk cmdlet atau perintah, seperti fungsi, skrip, file, atau executable lainnya. Alias adalah nama alternatif yang mengacu pada cmdlet atau perintah. Misalnya, sal adalah alias untuk Set-Alias cmdlet. Untuk informasi selengkapnya, lihat about_Aliases.

Cmdlet dapat memiliki beberapa alias, tetapi alias hanya dapat dikaitkan dengan satu cmdlet. Anda dapat menggunakan Set-Alias untuk menetapkan ulang alias yang ada ke cmdlet lain, atau mengubah properti alias, seperti deskripsi.

Alias yang dibuat atau diubah Set-Alias tidak permanen dan hanya tersedia selama sesi PowerShell saat ini. Saat sesi PowerShell ditutup, alias dihapus.

Contoh

Contoh 1: Membuat alias untuk cmdlet

Perintah ini membuat alias ke cmdlet dalam sesi PowerShell saat ini.

PS> Set-Alias -Name list -Value Get-ChildItem

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

Set-Alias Cmdlet membuat alias dalam sesi PowerShell saat ini. Parameter Nama menentukan nama alias, list. Parameter Nilai menentukan cmdlet yang dijalankan alias.

Untuk menjalankan alias, ketik list pada baris perintah PowerShell.

Contoh 2: Menetapkan ulang alias yang ada ke cmdlet yang berbeda

Perintah ini menetapkan ulang alias yang ada untuk menjalankan cmdlet yang berbeda.

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

PS> Set-Alias -Name list -Value Get-Location

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-Location

Get-Alias Cmdlet menggunakan parameter Nama untuk menampilkan list alias. list Alias dikaitkan dengan Get-ChildItem cmdlet. list Saat alias dijalankan, item di direktori saat ini ditampilkan.

Set-Alias Cmdlet menggunakan parameter Nama untuk menentukan list alias. Parameter Nilai mengaitkan alias ke Get-Location cmdlet.

Get-Alias Cmdlet menggunakan parameter Nama untuk menampilkan list alias. list Alias dikaitkan dengan Get-Location cmdlet. list Saat alias dijalankan, lokasi direktori saat ini ditampilkan.

Contoh 3: Membuat dan mengubah alias baca-saja

Perintah ini membuat alias baca-saja. Opsi baca-saja mencegah perubahan yang tidak diinginkan pada alias. Untuk mengubah atau menghapus alias baca-saja, gunakan parameter Paksa .

Set-Alias -Name loc -Value Get-Location -Option ReadOnly -PassThru |
    Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         :
Name                : loc
CommandType         : Alias

$Parameters = @{
    Name        =  'loc'
    Value       =  (Get-Location)
    Option      =  'ReadOnly'
    Description =  'Displays the current directory'
    Force       = $true
    PassThru    = $true
}
Set-Alias @Parameters | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

Set-Alias Cmdlet membuat alias dalam sesi PowerShell saat ini. Parameter Nama menentukan nama alias, loc. Parameter Nilai menentukan Get-Location cmdlet yang dijalankan alias. Parameter Opsi menentukan nilai ReadOnly . Parameter PassThru mewakili objek alias dan mengirim objek ke bawah alur ke Format-List cmdlet. Format-Listmenggunakan parameter Properti dengan tanda bintang (*) sehingga setiap properti ditampilkan. Contoh output menunjukkan daftar parsial properti tersebut.

loc Alias diubah dengan penambahan dua parameter. Deskripsi menambahkan teks untuk menjelaskan tujuan alias. Parameter Force diperlukan karena loc alias bersifat baca-saja. Jika parameter Force tidak digunakan, perubahan akan gagal.

Contoh 4: Membuat alias ke file yang dapat dieksekusi

Contoh ini membuat alias ke file yang dapat dieksekusi di komputer lokal.

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

Set-Alias Cmdlet membuat alias dalam sesi PowerShell saat ini. Parameter Nama menentukan nama alias, np. Parameter Nilai menentukan jalur dan nama C:\Windows\notepad.exeaplikasi . Get-Alias Cmdlet menggunakan parameter Nama untuk menunjukkan bahwa np alias dikaitkan dengan notepad.exe.

Untuk menjalankan alias, ketik np pada baris perintah PowerShell untuk membuka notepad.exe.

Contoh 5: Membuat alias untuk perintah dengan parameter

Contoh ini menunjukkan cara menetapkan alias ke perintah dengan parameter.

Anda dapat membuat alias untuk cmdlet, seperti Set-Location. Anda tidak dapat membuat alias untuk perintah dengan parameter dan nilai, seperti Set-Location -Path C:\Windows\System32. Untuk membuat alias untuk perintah, buat fungsi yang menyertakan perintah , lalu buat alias ke fungsi . Untuk informasi selengkapnya, lihat about_Functions.

Function CD32 {Set-Location -Path C:\Windows\System32}

Set-Alias -Name Go -Value CD32

Fungsi bernama CD32 dibuat. Fungsi ini menggunakan Set-Location cmdlet dengan parameter Jalur untuk menentukan direktori, C:\Windows\System32.

Set-Alias Cmdlet membuat alias ke fungsi dalam sesi PowerShell saat ini. Parameter Nama menentukan nama alias, Go. Parameter Nilai menentukan nama fungsi, CD32.

Untuk menjalankan alias, ketik Go pada baris perintah PowerShell. Fungsi CD32 berjalan dan berubah ke direktori C:\Windows\System32.

Contoh 6: Memperbarui opsi untuk alias yang sudah ada

Contoh ini menunjukkan cara menetapkan beberapa opsi menggunakan parameter Opsi .

Melanjutkan dari contoh sebelumnya, atur alias Go sebagai ReadOnly dan Private.

Set-Alias -Name Go -Option ReadOnly, Private

Alias Go harus sudah ada. Setelah menjalankan perintah, alias tidak dapat diubah tanpa menggunakan parameter Force dan hanya tersedia dalam cakupan saat ini.

Parameter

-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 alias. Anda dapat mengetik string apa pun. Jika deskripsi menyertakan spasi, sertakan dalam tanda kutip tunggal.

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

-Force

Gunakan parameter Paksa untuk mengubah atau menghapus alias yang memiliki parameter Opsi yang diatur ke ReadOnly.

Parameter Paksa tidak dapat mengubah atau menghapus alias dengan parameter Opsi diatur ke Konstanta.

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

-Name

Menentukan nama alias baru. Nama alias dapat berisi karakter alfanumerik dan tanda hubung. Nama alias tidak boleh numerik, seperti 123.

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

-Option

Mengatur nilai properti Opsi alias. Nilai seperti ReadOnly dan Constant melindungi alias dari perubahan yang tidak diinginkan. Untuk melihat properti Opsi dari semua alias dalam sesi, ketik Get-Alias | Format-Table -Property Name, Options -Autosize.

Nilai yang dapat diterima untuk parameter ini adalah sebagai berikut:

  • AllScope - Alias disalin ke cakupan baru yang dibuat.
  • Constant - Tidak dapat diubah atau dihapus.
  • None - Mengatur tidak ada opsi dan merupakan default.
  • Private - Alias hanya tersedia dalam cakupan saat ini.
  • ReadOnly - Tidak dapat diubah atau dihapus kecuali parameter Paksa digunakan.
  • Unspecified

Nilai-nilai ini didefinisikan sebagai enumerasi berbasis bendera. Anda dapat menggabungkan beberapa nilai bersama-sama untuk mengatur beberapa bendera menggunakan parameter ini. Nilai dapat diteruskan ke parameter Opsi sebagai array nilai atau sebagai string yang dipisahkan koma dari nilai tersebut. Cmdlet menggabungkan nilai menggunakan operasi biner-OR. Meneruskan nilai sebagai array adalah opsi paling sederhana dan juga memungkinkan Anda menggunakan penyelesaian tab pada nilai.

Type:ScopedItemOptions
Accepted values:AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Mengembalikan objek yang mewakili alias. Gunakan cmdlet format seperti Format-List untuk menampilkan objek. Secara default, Set-Alias tidak menghasilkan output apa pun.

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

-Scope

Menentukan cakupan tempat alias ini valid. Nilai defaultnya adalah Lokal. Untuk informasi selengkapnya, lihat about_Scopes.

Nilai yang dapat diterima adalah sebagai berikut:

  • Global
  • Local
  • Private
  • Numbered scopes
  • Script
Type:String
Accepted values:Global, Local, Private, Numbered scopes, Script
Position:Named
Default value:Local
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Menentukan nama cmdlet atau perintah yang dijalankan alias. Parameter Nilai adalah properti Definisi alias.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
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 Set-Alias:

  • Semua platform:
    • sal

PowerShell menyertakan alias bawaan yang tersedia di setiap sesi PowerShell. Get-Alias Cmdlet menampilkan alias yang tersedia dalam sesi PowerShell.

Untuk membuat alias, gunakan cmdlet Set-Alias atau New-Alias. Di PowerShell 6, untuk menghapus alias, gunakan Remove-Alias cmdlet . Remove-Item diterima untuk kompatibilitas mundur seperti untuk skrip yang dibuat dengan versi PowerShell sebelumnya. Gunakan perintah seperti Remove-Item -Path Alias:aliasname.

Untuk membuat alias yang tersedia di setiap sesi PowerShell, tambahkan ke profil PowerShell Anda. Untuk informasi selengkapnya, lihat about_Profiles.

Alias dapat disimpan dan digunakan kembali di sesi PowerShell lain dengan melakukan ekspor dan impor. Untuk menyimpan alias ke file, gunakan Export-Alias. Untuk menambahkan alias tersimpan ke sesi PowerShell baru, gunakan Import-Alias.