HOME > Alias系コマンドレット > Set-Alias
Set-Alias
Set-Aliasは、エイリアスを設定するコマンドです。
エイリアスsal
解説
エイリアスを新規作成または更新します。
同名のエイリアスが存在しない場合は新規作成され、
同名のエイリアスが既に存在する場合は更新されます。
構文
- (構文)
- Set-Alias [-Name] <string> [-Value] <string> [<CommonParameters>]
パラメータ | 説明 |
---|---|
-Name エイリアス名 | エイリアス名を指定する |
-Value コマンド名 | エイリアスを設定するコマンド名を指定する |
-Description 説明 | 説明文を指定する |
-Option オプション | オプションを指定する ・None ・ReadOnly ・Constant ・Private ・AllScope |
-PassThru | 通常は出力しない値を出力るようにする |
-Scope 値 | 対象とするスコープを指定する ・Global:どこからでも読書き可能 ・Local:現在のスコープのみ読書き可能(※既定値) ・Script:スクリプト内のみ読書き可能 |
-Force | 強制的に実行する |
-WhatIf | 実行はせずに実行結果の確認のみ行う |
-Confirm | 実行前に確認メッセージの表示を行う |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
コマンドレット「Get-Date」に対してgdというエイリアスを設定する
Set-Alias -Name gd -Value Get-Date
#以下のように-Nameと-Valueを省略できます。
Set-Alias gd Get-Date
説明を指定しつつエイリアスを設定する
Set-Alias -Name gd -Value Get-Date -Description 説明です
エイリアス作成前に確認メッセージを表示する
Set-Alias -Name gd -Value Get-Date -Confirm
コマンドのヘルプを表示する
Get-Help Set-Alias
備考
- 作成したエイリアスを削除したい場合はRemove-Itemコマンドレットを使用してください。
(例)エイリアスgdを削除する ⇒Remove-Item alias:gd
関連項目
- Alias系コマンドレット
- Get-Alias:エイリアスを取得する
- Set-Alias:エイリアスを設定する
- New-Alias:エイリアスを作成する
- Export-Alias:エイリアスをエクスポートする
- Import-Alias:エイリアスをインポートする