Get-Alias

モジュール:: Microsoft.PowerShell.Utility

現在のセッションのエイリアスを取得します。

構文

Get-Alias
   [[-Name] <String[]>]
   [-Exclude <String[]>]
   [-Scope <String>]
   [<CommonParameters>]

Get-Alias
   [-Exclude <String[]>]
   [-Scope <String>]
   [-Definition <String[]>]
   [<CommonParameters>]

説明

Get-Alias コマンドレットは、現在のセッションのエイリアスを取得します。これには、組み込みのエイリアス、設定またはインポートしたエイリアス、PowerShell プロファイルに追加したエイリアスが含まれます。

既定では、 Get-Alias はエイリアスを受け取り、コマンド名を返します。 Definition パラメーターを使用すると、Get-Alias はコマンド名を受け取り、そのエイリアスを返します。

Windows PowerShell 3.0 以降、 Get-Alias では、必要な情報をさらに簡単に見つけることができるように、ハイフンでつながれていないエイリアス名が <alias> -> <definition> 形式で表示されます。

例

例 1: 現在のセッションのすべてのエイリアスを取得する

PS C:\> Get-Alias

CommandType     Name
-----------     ----
Alias           % -> ForEach-Object
Alias           ? -> Where-Object
Alias           ac -> Add-Content
Alias           asnp -> Add-PSSnapin
Alias           cat -> Get-Content
Alias           cd -> Set-Location
Alias           chdir -> Set-Location
Alias           clc -> Clear-Content
Alias           clear -> Clear-Host
Alias           clhy -> Clear-History
...

このコマンドは、現在のセッションのすべてのエイリアスを取得します。

出力には、Windows PowerShell 3.0 で導入された <alias> -> <definition> 形式が表示されます。この形式は、ハイフンを含まないエイリアスにのみ使用されます。通常、ハイフンを含むエイリアスは、ニックネームではなくコマンドレットと関数の名前として推奨されるためです。

例 2: 名前でエイリアスを取得する

Get-Alias -Name gp*, sp* -Exclude *ps

このコマンドは、ps で終わるエイリアスを除き、gp または sp で始まるすべてのエイリアスを取得します。

例 3: コマンドレットのエイリアスを取得する

Get-Alias -Definition Get-ChildItem

このコマンドは、Get-ChildItem コマンドレットのエイリアスを取得します。

既定では、 Get-Alias コマンドレットは、エイリアスがわかっている場合に項目名を取得します。定義パラメーターは、項目名がわかっている場合にエイリアスを取得します。

例 4: プロパティでエイリアスを取得する

Get-Alias | Where-Object {$_.Options -Match "ReadOnly"}

このコマンドは、Options プロパティの値が ReadOnly であるすべてのエイリアスを取得します。このコマンドを使用すると、PowerShell に組み込まれているエイリアスをすばやく見つける方法が提供されます。エイリアスには ReadOnly オプションがあります。

Options は、 Get-Alias が取得する AliasInfo オブジェクトの 1 つのプロパティにすぎません。 AliasInfo オブジェクトのすべてのプロパティとメソッドを検索するには、「 Get-Alias | get-member」と入力します。

例 5: 名前でエイリアスを取得し、先頭文字でフィルター処理する

Get-Alias -Definition "*-PSSession" -Exclude e* -Scope Global

この例では、"-PSSession" で終わる名前を持つコマンドのエイリアスを取得します。ただし、"e" で始まるコマンドを除く。

このコマンドは、Scope パラメーターを使用して、グローバルスコープにコマンドを適用します。これは、セッションでエイリアスを取得する場合にスクリプトで役立ちます。

パラメーター

-Definition

指定した項目のエイリアスを取得します。コマンドレット、関数、スクリプト、ファイル、または実行可能ファイルの名前を入力します。

このパラメーターは、エイリアスオブジェクトの Definition プロパティで項目名を検索するため、定義呼び出されます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Exclude

指定した項目を省略します。このパラメーターの値によって、Name パラメーターと Definition パラメーターが修飾されます。名前、定義、またはパターン ("s*" など) を入力します。ワイルドカードを使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Name

このコマンドレットが取得するエイリアスを指定します。ワイルドカードを使用できます。既定では、Get-Alias は現在のセッションに対して定義されているすべてのエイリアスを取得します。パラメーター名名前は省略可能です。エイリアス名をパイプして Get-Aliasすることもできます。

型:	String[]
配置:	0
規定値:	All aliases
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-Scope

このコマンドレットがエイリアスを取得するスコープを指定します。このパラメーターに使用できる値は次のとおりです。

グローバル
ローカル
スクリプト
現在のスコープに対する相対的な数値（スコープ数は0から始まり、0は現在のスコープ、1はその親スコープを表します）

既定値は Local です。詳細については、「about_Scopes」を参照してください。

型:	String
配置:	Named
規定値:	Local
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String

エイリアス名を Get-Alias にパイプできます。

出力

AliasInfo

Get-Alias は、各エイリアスを表すオブジェクトを返します。 Get-Alias はすべてのエイリアスに対して同じオブジェクトを返しますが、PowerShell では矢印ベースの形式を使用して、ハイフンでつながれていないエイリアスの名前を表示します。

メモ

新しいエイリアスを作成するには、Set-Alias または New-Alias を使用します。エイリアスを削除するには、Remove-Item を使用します。
矢印ベースのエイリアス名の形式は、ハイフンを含むエイリアスには使用されません。これらは、一般的な省略形やニックネームではなく、コマンドレットと関数の代わりの名前として推奨される可能性があります。