New-Alias
新しいエイリアスを作成します。
構文
New-Alias
[-Name] <String>
[-Value] <String>
[-Description <String>]
[-Option <ScopedItemOptions>]
[-PassThru]
[-Scope <String>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
New-Alias コマンドレットは、現在の Windows PowerShell セッションに新しいエイリアスを作成します。 New-Alias を使用して作成されたエイリアスは、セッションを終了した後、または Windows PowerShell を閉じた後は保存されません。 Export-Alias コマンドレットを使用して、エイリアス情報をファイルに保存できます。 後で Import-Alias を使用して、保存したエイリアス情報を取得できます。
例
例 1: コマンドレットのエイリアスを作成する
PS C:\> New-Alias -Name "List" Get-ChildItemこのコマンドは、Get-ChildItem コマンドレットを表す List という名前のエイリアスを作成します。
例 2: コマンドレットの読み取り専用エイリアスを作成する
PS C:\> New-Alias -Name "W" -Value Get-WmiObject -Description "quick wmi alias" -Option ReadOnly
PS C:\> Get-Alias -Name "W" | Format-List *このコマンドは、Get-WmiObject コマンドレットを表す W という名前のエイリアスを作成します。 このエイリアスの説明 quick wmi alias を作成し、読み取り専用にします。 コマンドの最後の行では、Get-Alias を使用して新しいエイリアスを取得し、それを Format-List にパイプして、それに関するすべての情報を表示します。
パラメーター
-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 プロパティの値を指定します。 有効な値は次のとおりです。
- なし: エイリアスには制約がありません (デフォルト値)
- ReadOnly: エイリアスは削除できますが、 Force パラメーターを使用しない場合以外は変更できません
- 定数: エイリアスは削除または変更できません
- プライベート: エイリアスは現在のスコープでのみ使用できます
- AllScope: エイリアスは、作成された新しいスコープにコピーされます
- 未指定: オプションは指定されていません
セッション内のすべてのエイリアスの 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
新しいエイリアスのスコープを指定します。 このパラメーターに使用できる値は次のとおりです。
- グローバル
- ローカル
- スクリプト
- 現在のスコープに対する相対的な数値 (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 or System.Management.Automation.AliasInfo
Passthru パラメータを使用すると、New-Alias は新しいエイリアスを表す System.Management.Automation.AliasInfo オブジェクトを生成します。 それ以外の場合、このコマンドレットは出力を生成しません。
メモ
新しいエイリアスを作成するには、Set-Alias または New-Alias を使用します。 エイリアスを変更するには、 Set-Alias を使用します。 エイリアスを削除するには、Remove-Item を使用します。