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: コマンドレットの読み取り専用エイリアスを作成する
New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *このコマンドは、コマンドレットを表す名前の C エイリアスを Get-ChildItem 作成します。 エイリアスの説明、簡易 wmi エイリアスを作成し、読み取り専用にします。 コマンドの最後の行は、新しいエイリアスを取得し、それに関するすべての情報を表示するためにFormat-Listにパイプするために使用 Get-Alias します。
パラメーター
-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 プロパティの値を指定します。 有効な値は次のとおりです。
None: エイリアスに制約がありません (既定値)ReadOnly: エイリアスは削除できますが、 Force パラメーターを使用する以外は変更できません。Constant: エイリアスを削除または変更することはできません。Private: エイリアスは現在のスコープでのみ使用できますAllScope: エイリアスは、作成された新しいスコープにコピーされます。Unspecified: オプションが指定されていません
これらの値は、フラグ ベースの列挙体として定義されます。 複数の値を組み合わせて、このパラメーターを使用して複数のフラグを設定できます。 値は、値の配列として、またはそれらの値のコンマ区切り文字列として Option パラメーターに渡すことができます。 このコマンドレットは、バイナリ OR 操作を使用して値を結合します。 配列として値を渡すことは最も簡単なオプションであり、値にタブ補完を使用することもできます。
セッション内のすべてのエイリアスの 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
新しいエイリアスのスコープを指定します。 このパラメーターの有効値は、次のとおりです。
GlobalLocalScript- 現在のスコープに対する相対的な数値 (0 からスコープの数。現在
0のスコープとその1親)。
Local が既定値です。 詳細については、 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 パラメーターを使用すると、New-Alias新しいエイリアスを表す System.Management.Automation.AliasInfo オブジェクトが生成されます。 それ以外の場合、このコマンドレットによる出力はありません。
メモ
- 新しいエイリアスを作成するには、次を使用するか、 を使用
Set-AliasしますNew-Alias。 エイリアスを変更するには、次を使用しますSet-Alias。 エイリアスを削除するには、次を使用しますRemove-Item。