Set-Alias

Set-Alias コマンドレットは、関数、スクリプト、ファイル、その他の実行可能ファイルなどのコマンドレットまたはコマンドのエイリアスを作成または変更します。 エイリアスは、コマンドレットまたはコマンドを参照する代替名です。 たとえば、sal は、Set-Alias コマンドレットのエイリアスです。 詳細については、about_Aliasesを参照してください。

コマンドレットは複数のエイリアスを持つことができますが、エイリアスは 1 つのコマンドレットにのみ関連付けることができます。 Set-Alias を使用して、既存のエイリアスを別のコマンドレットに再割り当てしたり、説明などのエイリアスのプロパティを変更したりできます。

Set-Alias によって作成または変更されたエイリアスは永続的ではなく、現在の PowerShell セッション中のみ使用できます。 PowerShell セッションが閉じられると、エイリアスが削除されます。

このコマンドは、現在の PowerShell セッションでコマンドレットのエイリアスを作成します。

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

PS> Get-Alias -Name list

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

Set-Alias コマンドレットは、現在の PowerShell セッションにエイリアスを作成します。 Name パラメーターは、エイリアスの名前 (list) を指定します。 Value パラメーターは、エイリアスを実行するコマンドレットを指定します。

エイリアスを実行するには、PowerShell コマンド ラインで「list」と入力します。

このコマンドは、別のコマンドレットを実行するために既存のエイリアスを再割り当てします。

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 コマンドレットは、Name パラメーターを使用して、list エイリアスを表示します。 list エイリアスは、Get-ChildItem コマンドレットに関連付けられています。 list エイリアスを実行すると、現在のディレクトリ内の項目が表示されます。

Set-Alias コマンドレットでは、Name パラメーターを使用して、list エイリアスを指定します。 Value パラメーターは、エイリアスを Get-Location コマンドレットに関連付けます。

Get-Alias コマンドレットは、Name パラメーターを使用して、list エイリアスを表示します。 list エイリアスは、Get-Location コマンドレットに関連付けられています。 list エイリアスを実行すると、現在のディレクトリの場所が表示されます。

このコマンドは、読み取り専用のエイリアスを作成します。 読み取り専用オプションは、エイリアスに対する意図しない変更を防ぎます。 読み取り専用エイリアスを変更または削除するには、Force パラメーターを使用します。

PS> 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

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | Format-List -Property *

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

Set-Alias コマンドレットは、現在の PowerShell セッションにエイリアスを作成します。 Name パラメーターは、エイリアスの名前 (loc) を指定します。 Value パラメーターは、エイリアスを実行する Get-Location コマンドレットを指定します。 Option パラメーターは、ReadOnly 値を指定します。 PassThru パラメーターはエイリアス オブジェクトを表し、そのオブジェクトをパイプラインから Format-List コマンドレットに送信します。 Format-Listは、アスタリスク () 付きの * パラメーターを使用して、すべてのプロパティが表示されるようにします。 出力例は、これらのプロパティの一部の一覧を示しています。

loc エイリアスは、2 つのパラメーターを追加して変更されます。 説明 エイリアスの目的を説明するテキストを追加します。 エイリアスは読み取り専用であるため、loc パラメーターが必要です。 Force パラメータを使用しない場合、変更は失敗します。

次の使用例は、ローカル コンピューター上の実行可能ファイルのエイリアスを作成します。

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

PS> Get-Alias -Name np

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

Set-Alias コマンドレットは、現在の PowerShell セッションにエイリアスを作成します。 Name パラメーターは、エイリアスの名前 (np) を指定します。 Value パラメータは、パスとアプリケーション名を指定します C:\Windows\notepad.exe。 Get-Alias コマンドレットは Name パラメーターを使用して、np エイリアスが notepad.exeに関連付けられていることを示します。

エイリアスを実行するには、PowerShell コマンド ラインに「 np 」と入力して notepad.exeを開きます。

この例では、パラメーターを使用してコマンドにエイリアスを割り当てる方法を示します。

コマンドレットのエイリアス (Set-Locationなど) を作成できます。 パラメータと値 ( Set-Location -Path C:\Windows\System32 など) を持つコマンドのエイリアスを作成することはできません。 コマンドのエイリアスを作成するには、コマンドを含む関数を作成し、関数のエイリアスを作成します。 詳細については、about_Functionsを参照してください。

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

PS> Set-Alias -Name Go -Value CD32

CD32 という名前の関数が作成されます。 この関数では、 Set-Location コマンドレットと Path パラメーターを使用して、ディレクトリ C:\Windows\System32 を指定します。

Set-Alias コマンドレットは、現在の PowerShell セッションで関数のエイリアスを作成します。 Name パラメーターは、エイリアスの名前 (Go) を指定します。 Value パラメーターは、関数の名前である CD32を指定します。

エイリアスを実行するには、PowerShell コマンド ラインで「Go」と入力します。 CD32 関数が実行され、ディレクトリ C:\Windows\System32 に移動します。

None

Set-Alias パイプラインからの入力を受け入れません。

None or System.Management.Automation.AliasInfo

PassThru パラメーターを使用すると、Set-Alias はエイリアスを表す System.Management.Automation.AliasInfo オブジェクトを生成します。 それ以外の場合、 Set-Alias は出力を生成しません。

PowerShell には、各 PowerShell セッションで使用できる組み込みのエイリアスが含まれています。 Get-Alias コマンドレットは、PowerShell セッションで使用可能なエイリアスを表示します。

新しいエイリアスを作成するには、Set-Alias または New-Aliasを使用します。 エイリアスを削除するには、Remove-Item コマンドレットを使用します。 たとえば、Remove-Item -Path Alias:aliasname のようにします。

各 PowerShell セッションで使用できるエイリアスを作成するには、それを PowerShell プロファイルに追加します。 詳細については、about_Profilesを参照してください。

エイリアスは、エクスポートとインポートを行うことで、別の PowerShell セッションで保存および再利用できます。 エイリアスをファイルに保存するには、Export-Aliasを使用します。 保存したエイリアスを新しい PowerShell セッションに追加するには、Import-Aliasを使用します。