Set-Alias
現在の PowerShell セッションでコマンドレットまたはその他のコマンドのエイリアスを作成または変更します。
構文
Set-Alias
[-Name] <string>
[-Value] <string>
[-Description <string>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <string>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
コマンドレットは Set-Alias 、関数、スクリプト、ファイル、その他の実行可能ファイルなどのコマンドレットまたはコマンドのエイリアスを作成または変更します。 別名は、コマンドレットまたはコマンドを参照する代替名です。
たとえば、 sal は コマンドレットの Set-Alias エイリアスです。 詳細については、「about_Aliases」を参照してください。
コマンドレットは複数のエイリアスを持つことができますが、エイリアスは 1 つのコマンドレットにのみ関連付けることができます。 を使用 Set-Alias して、既存のエイリアスを別のコマンドレットに再割り当てしたり、エイリアスのプロパティ (説明など) を変更したりできます。
によって Set-Alias 作成または変更されたエイリアスは永続的ではなく、現在の PowerShell セッション中にのみ使用できます。 PowerShell セッションが閉じられると、エイリアスが削除されます。
例
例 1: コマンドレットのエイリアスをCreateする
このコマンドは、現在の 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 します。
例 2: 既存のエイリアスを別のコマンドレットに再割り当てする
このコマンドは、別のコマンドレットを実行するために既存のエイリアスを再割り当てします。
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-AliasName パラメーターを使用してエイリアスを指定します list 。 Value パラメーターは、エイリアスをコマンドレットにGet-Location関連付けます。
コマンドレットはGet-Alias、Name パラメーターを使用してエイリアスをlist表示します。 エイリアスは list コマンドレットに Get-Location 関連付けられています。 エイリアスを list 実行すると、現在のディレクトリの場所が表示されます。
例 3: 読み取り専用エイリアスをCreateして変更する
このコマンドは、読み取り専用エイリアスを作成します。 読み取り専用オプションを使用すると、エイリアスに対する意図しない変更を防ぐことができます。 読み取り専用エイリアスを変更または削除するには、 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 では、 Property パラメーターとアスタリスク (*) を使用して、すべてのプロパティが表示されます。 出力例は、これらのプロパティの一部の一覧を示しています。
エイリアスは loc 、2 つのパラメーターを追加して変更されます。 Description は、エイリアスの目的を説明するテキストを追加します。 エイリアスが読み取り専用であるため、locForce パラメーターが必要です。 Force パラメーターを使用しない場合、変更は失敗します。
例 4: 実行可能ファイルに別名をCreateする
次の使用例は、ローカル コンピューター上の実行可能ファイルにエイリアスを作成します。
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開きます。
例 5: パラメーターを含むコマンドの別名をCreateする
この例では、パラメーターを使用してコマンドにエイリアスを割り当てる方法を示します。
などのコマンドレット 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-LocationPath パラメーターを使用して、ディレクトリ C:\Windows\System32 を指定します。
コマンドレットは Set-Alias 、現在の PowerShell セッションで関数のエイリアスを作成します。 Name パラメーターは、Goエイリアスの名前 を指定します。 Value パラメーターは、関数の名前 を指定しますCD32。
エイリアスを実行するには、PowerShell コマンド ラインで を入力 Go します。 関数が CD32 実行され、ディレクトリ C:\Windows\System32 に変更されます。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
エイリアスの説明を指定します。 任意の文字列を入力できます。 説明にスペースが含まれている場合は、単一引用符で囲みます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Option パラメーターが ReadOnly に設定されているエイリアスを変更または削除するには、Force パラメーターを使用します。
Force パラメーターは、Option パラメーターが Constant に設定されているエイリアスを変更または削除できません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
新しいエイリアスの名前を指定します。 別名には英数字を含めることができます。 エイリアス名は、123 などの数値にすることはできません。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Option
エイリアスの Option プロパティ値を設定します。 ReadOnly や Constant などの値は、意図しない変更からエイリアスを保護します。 セッション内のすべてのエイリアスの Option プロパティを表示するには、「」と入力します Get-Alias | Format-Table -Property Name, Options -Autosize。
このパラメーターに使用できる値は次のとおりです。
- AllScope エイリアスは、作成された新しいスコープにコピーされます。
- 定数 変更または削除できません。
- なし オプションを設定せず、既定値を指定します。
- プライベート エイリアスは、現在のスコープでのみ使用できます。
- ReadonlyForce パラメーターを使用しない限り、変更または削除できません。
- 未指定
| 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
エイリアスを表すオブジェクトを返します。 オブジェクトを表示するには、 などの Format-List 形式コマンドレットを使用します。 既定では、 Set-Alias は出力を生成しません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
このエイリアスが有効なスコープを指定します。 既定値は Local です。 詳細については、「 about_Scopes」を参照してください。
許容される値は次のとおりです。
- グローバル
- ローカル
- プライベート
- 番号付きスコープ
- スクリプト
| 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
エイリアスが実行するコマンドレットまたはコマンドの名前を指定します。 Value パラメーターは、エイリアスの Definition プロパティです。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
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します。