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: 現在のセッションのすべてのエイリアスを取得する

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
...

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

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

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

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

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

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

Get-Alias -Definition Get-ChildItem

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

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

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

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

このコマンドは、Options プロパティの値が ReadOnly であるすべてのエイリアスを取得します。 このコマンドを使用すると、PowerShell に組み込まれているエイリアスを簡単に検索できます。これは ReadOnly オプションがあるためです。

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

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

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

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

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

パラメーター

-Definition

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

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Exclude

指定した項目を除外します。 このパラメーターの値は、Name パラメーターと Definition パラメーターを修飾します。 名前、要素、または「s*」のようなパターンを入力します。 ワイルドカードを使用できます。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

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

Type:String[]
Position:0
Default value:All aliases
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Scope

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

  • Global
  • Local
  • Script
  • 現在のスコープに対する相対的な数値 (0 からスコープの数、0 が現在のスコープ、1 がその親)

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

Type:String
Position:Named
Default value:Local
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

エイリアス名を含む文字列をこのコマンドレットにパイプできます。

出力

AliasInfo

このコマンドレットは、各エイリアスを表すオブジェクトを返します。 すべてのエイリアスに対して同じ種類のオブジェクトが返されますが、PowerShell では矢印ベースの形式を使用して、ハイフネーションされていないエイリアスの名前が表示されます。

メモ

PowerShell には、次のエイリアスが Get-Alias含まれています。

  • すべてのプラットフォーム:

    • gal

  • 新しいエイリアスを作成するには、 Set-Alias または New-Alias. エイリアスを削除するには、次を使用します Remove-Item。

  • 矢印に基づくエイリアス名の形式は、ハイフンを含むエイリアスには使用されません。 これらは、一般的な省略形またはニックネームの代わりに、コマンドレットと関数の推奨される代替名となる可能性が高くなります。