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: コマンドレットのエイリアスをCreateする
PS C:\> New-Alias -Name "List" Get-ChildItemこのコマンドは、Get-ChildItem コマンドレットを表す List という名前のエイリアスを作成します。
例 2: コマンドレットの読み取り専用エイリアスをCreateする
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 という名前のエイリアスを作成します。 これにより、エイリアスの説明 (簡易 wmi エイリアス) が作成され、読み取り専用になります。 コマンドの最後の行は、Get-Alias を使用して新しいエイリアスを取得し、パイプを使用して Format-List に渡します。これによりすべての情報が表示されます。
パラメーター
-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
という名前のエイリアスが既に存在する場合、コマンドレットが Set-Alias のように動作することを示します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
新しいエイリアスを指定します。 エイリアス名には任意の英数字を使用できますが、最初の文字を数字にすることはできません。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Option
エイリアスの Options プロパティの値を指定します。 有効な値は次のとおりです。
- なし: エイリアスに制約はありません (既定値)
- ReadOnly: エイリアスは削除できますが、 Force パラメーターを使用する以外は変更できません
- 定数: エイリアスを削除または変更することはできません
- プライベート: エイリアスは現在のスコープでのみ使用できます
- AllScope: エイリアスは、作成された新しいスコープにコピーされます
- 指定なし: オプションが指定されていません
セッション内のすべてのエイリアスの Options プロパティを表示するには、「」と入力します Get-Alias | Format-Table -Property Name, Options -AutoSize。
| Type: | ScopedItemOptions |
| Accepted values: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
| Position: | Named |
| Default value: | [System.Management.Automation.ScopedItemOptions]::None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
新しいエイリアスのスコープを指定します。 このパラメーターの有効値は、次のとおりです。
- グローバル
- ローカル
- スクリプト
- 現在のスコープに対する相対的な数値 (0 からスコープの数まで、0 は現在のスコープ、1 はその親)。
[ローカル] が既定値です。 詳細については、「about_Scopes」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Value
エイリアスを作成するコマンドレットまたはコマンド要素の名前を指定します。
| 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
パイプを使用してこのコマンドレットに入力を渡すことはできません。
出力
None or System.Management.Automation.AliasInfo
Passthru パラメーターを使用すると、新しいエイリアスを表す System.Management.Automation.AliasInfo オブジェクトが New-Alias によって生成されます。 それ以外の場合、このコマンドレットによる出力はありません。
メモ
新しいエイリアスを作成するには、Set-Alias または New-Alias を使用します。 エイリアスを変更するには、 Set-Alias を使用します。 エイリアスを削除するには、Remove-Item を使用します。