New-Alias
新しいエイリアスを作成します。
構文
New-Alias
[-Name] <String>
[-Value] <String>
[-Description <String>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
New-Alias
コマンドレットは、現在の PowerShell セッションに新しいエイリアスを作成します。 New-Alias
を使用して作成されたエイリアスは、セッションを終了した後や PowerShell を閉じた後は保存されません。
Export-Alias
コマンドレットを使用して、エイリアス情報をファイルに保存できます。 後で Import-Alias
を使用して、保存されたエイリアス情報を取得できます。
例
例 1: コマンドレットのエイリアスを作成する
New-Alias -Name "List" Get-ChildItem
このコマンドは、Get-ChildItem コマンドレットを表す List という名前のエイリアスを作成します。
例 2: コマンドレットの読み取り専用エイリアスを作成する
このコマンドは、Get-ChildItem
コマンドレットを表す C
という名前のエイリアスを作成します。 エイリアスの "クイック gci エイリアス" の説明を作成し、読み取り専用にします。
New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *
HelpUri : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName : C -> Get-ChildItem
ReferencedCommand : Get-ChildItem
ResolvedCommand : Get-ChildItem
Definition : Get-ChildItem
Options : ReadOnly
Description : quick gci alias
OutputType : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name : C
CommandType : Alias
Source :
Version :
Visibility : Public
ModuleName :
Module :
RemotingCapability : PowerShell
Parameters : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
System.Management.Automation.ParameterMetadata], [Filter,
System.Management.Automation.ParameterMetadata], [Include,
System.Management.Automation.ParameterMetadata]…}
Format-List
にパイプされた Get-Alias
コマンドは、新しいエイリアスに関するすべての情報を表示します。
例 3: パラメーターを使用してコマンドの別名を作成する
function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory
1 つ目のコマンドは、Set-Location
を使用して作業場所を親ディレクトリに設定する関数Set-ParentDirectory
を作成します。 2 番目のコマンドでは、New-Alias
を使用して、Set-ParentDirectory
関数を呼び出す..
のエイリアスを作成します。 Value パラメーターにはコマンドレット、関数、または実行可能な値が必要であるため、パラメーターを使用するエイリアスを作成するカスタム関数を作成する必要があります。 エイリアス ..
を実行すると、現在の場所が親ディレクトリに変更されます。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
エイリアスの説明を指定します。 任意の文字列を入力できます。 説明にスペースが含まれる場合は、二重引用符で囲みます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
名前付きのエイリアスが既に存在する場合、コマンドレットが Set-Alias
のように動作することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
新しいエイリアスを指定します。 エイリアス名には任意の英数字を使用できますが、最初の文字を数字にすることはできません。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Option
エイリアスの Options プロパティの値を指定します。 有効な値は次のとおりです。
None
: エイリアスに制約がありません (既定値)ReadOnly
: エイリアスは削除できますが、 Force パラメーターを使用する以外は変更できません。Constant
: エイリアスは削除または変更できませんPrivate
: エイリアスは現在のスコープでのみ使用できますAllScope
: エイリアスは、作成された新しいスコープにコピーされます。Unspecified
: オプションが指定されていません
これらの値は、フラグ ベースの列挙体として定義されます。 このパラメーターを使用して、複数の値を組み合わせて複数のフラグを設定できます。 値は、 Option パラメーターに値の配列として、またはそれらの値のコンマ区切り文字列として渡すことができます。 コマンドレットは、バイナリ OR 操作を使用して値を結合します。 配列として値を渡すことは最も簡単なオプションであり、値にタブ補完を使用することもできます。
セッション内のすべてのエイリアスの Options プロパティを表示するには、「 Get-Alias | Format-Table -Property Name, Options -AutoSize
」と入力します。
型: | ScopedItemOptions |
指定可能な値: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
配置: | Named |
規定値: | [System.Management.Automation.ScopedItemOptions]::None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PassThru
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Scope
新しいエイリアスのスコープを指定します。 このパラメーターの有効値は、次のとおりです。
Global
Local
Script
- 現在のスコープに対する相対的な数値 (0 からスコープの数。ここで、
0
は現在のスコープ、1
はその親)。
Local
は既定値です。 詳細については、「 about_Scopes」を参照してください。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Value
エイリアスを作成するコマンドレットまたはコマンド要素の名前を指定します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットにオブジェクトをパイプすることはできません。
出力
None
既定では、このコマンドレットは出力を返しません。
PassThru パラメーターを使用すると、このコマンドレットは新しいエイリアスを表す AliasInfo オブジェクトを返します。
メモ
Windows PowerShell には、 New-Alias
の次のエイリアスが含まれています。
nal
新しいエイリアスを作成するには、
Set-Alias
またはNew-Alias
を使用します。 エイリアスを変更するには、Set-Alias
を使用します。 エイリアスを削除するには、Remove-Item
を使用します。
関連リンク
PowerShell