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
新しいエイリアスのスコープを指定します。 このパラメーターの有効値は、次のとおりです。
Global
Local
Script
- 現在のスコープに対する相対的な数値 (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
既定では、このコマンドレットは出力を返しません。
PassThru パラメーターを使用すると、このコマンドレットは新しいエイリアスを表す AliasInfo オブジェクトを返します。
メモ
PowerShell には、次のエイリアスが New-Alias
含まれています。
すべてのプラットフォーム:
nal
新しいエイリアスを作成するには、
Set-Alias
またはNew-Alias
. エイリアスを変更するには、次を使用しますSet-Alias
。 エイリアスを削除するには、次を使用しますRemove-Alias
。
関連リンク
PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示