PowerShell Cmdlet - Set-Alias
 記事記号:[mg1981] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Set-Alias
    
概要
    現在の Windows PowerShell セッションでコマンドレットまたはその他のコマンド要
    素のエイリアス (別名) を作成または変更します。
    
構文
    Set-Alias [-Name] <string> [-Value] <string> [-Description <string>] [-Force
    ] [-Option {None | ReadOnly | Constant | Private | AllScope}] [-PassThru] [-
    Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
    
説明
    Set-Alias コマンドレットは、コマンドレットやコマンドの要素 (関数、スクリプト、
    ファイル、実行可能ファイルなど) のエイリアス (別名) を作成または変更します。
    また、Set-Alias を使用すると、現在のエイリアスの新しいコマンドへの再割り当て
    や、説明などのようなエイリアスのプロパティの変更を行うことができます。エイリ
    アスを Windows PowerShell プロファイルに追加しない限り、エイリアスに加えられ
    た変更は、セッションまたは Windows PowerShell の終了時に失われてしまいます。

パラメーター
    -Description <string>
        エイリアスについての説明を指定します。任意の文字列が入力可能です。説明に
        スペースが含まれる場合は、スペースを二重引用符で囲みます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        このコマンドレットが読み取り専用エイリアスを設定するのを許可します。読み
        取り専用エイリアスを作成するには、Option パラメーターを使用します。Force 
        パラメーターを使用して定数のエイリアスを設定することはできません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string>
        新しいエイリアスを指定します。エイリアス名には任意の英数字を使用できます
        が、数字で始めることはできません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Option <ScopedItemOptions>
        エイリアスの Options プロパティの値を設定します。
        
        有効な値は次のとおりです。
        
        -- None: オプションを設定しません (既定値)。
        
        -- ReadOnly: Force パラメーターを使用しない限り、エイリアスのプロパティ
           は変更できません。Remove-Item を使用すると、エイリアスを削除できます。
        
        -- Constant: エイリアスは削除できず、プロパティは変更できません。Constan
           t を指定できるのは、エイリアスを作成するときのみです。既存のエイリア
           スのオプションを Constant に変更することはできません。
        
        -- Private: Scope パラメーターで指定されたスコープ内でのみ、エイリアスを
           使用できます。それ以外のスコープでは表示されません。
        
        -- AllScope: エイリアスは、新たに作成されるすべてのスコープにコピーされ
           ます。
        
        エイリアスの Options プロパティを確認するには、「get-alias | format-tabl
        e -property Name, Definition, Options -autosize」と入力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        エイリアスを表すオブジェクトを返します。既定では、このコマンドレットによ
        る出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Scope <string>
        このエイリアスが有効なスコープを指定します。指定可能な値は、Global、Local、
        Script、または現在のスコープの相対的な数値 (0 〜スコープの数。ここで 0 は
        現在のスコープを表し、1 はその親を表す) です。既定値は Local です。詳細に
        ついては、「about_Scopes」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Value <string>
        エイリアスの作成対象とするコマンドレットまたはコマンド要素の名前を指定し
        ます。
        
        必須                         true
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    なし
        パイプを使用してこのコマンドレットに入力を渡すことはできません。
    
出力
    なし、または System.Management.Automation.AliasInfo
        PassThru パラメーターを使用すると、Set-Alias はエイリアスを表す System.M
        anagement.Automation.AliasInfo オブジェクトを生成します。それ以外の場合、
        このコマンドレットによる出力はありません。
    
メモ
        エイリアスは、コマンドレットまたはコマンド要素の別名またはニックネームで
        す。コマンドレットを実行するには、コマンドレットの完全な名前または有効な
        エイリアスを使用します。詳細については、「about_Aliases」を参照してくだ
        さい。
        
        新しいエイリアスを作成するには、Set-Alias または New-Alias を使用します。
        エイリアスを削除するには、Remove-Item を使用します。
        
        コマンドレットには複数のエイリアスを設定できますが、エイリアスは一度に 1 
        つのコマンドレットとのみ関連付けることができます。set-alias を使用してエ
        イリアスを別のコマンドレットと関連付けると、元のコマンドレットとの関連付
        けは解除されます。
        
        コマンドレットのエイリアスを作成することは可能ですが、パラメーターおよび
        値を持つコマンドのエイリアスは作成できません。たとえば、Set-Location の
        エイリアスは作成できますが、"Set-Location C:\Windows\System32" のエイリ
        アスは作成できません。コマンドのエイリアスを作成するには、コマンドを含む
        関数を作成し、その関数のエイリアスを作成します。
        
        あるセッションのエイリアスを保存し、別のセッションで使用するには、Window
        s PowerShell プロファイルに set-alias コマンドを追加します。既定では、プ
        ロファイルはありません。$profile 変数に保存されているパスにプロファイル
        を作成するには、「new-item -type file -force $profile」と入力します。$pr
        ofile 変数の値を確認するには、「$profile」と入力します。
        
        また、Export-Alias を使用してセッションのエイリアスをファイルにコピーし、
        Import-Alias を使用して新しいセッション用のエイリアス一覧に追加するとい
        う方法でエイリアスを保存することもできます。
        
        Set-Alias は、その組み込みエイリアスである "sal" で参照することもできま
        す。詳細については、「about_Aliases」を参照してください。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>set-alias -name list -value get-childitem
    
    説明
    -----------
    このコマンドは、Get-ChildItem コマンドレットのエイリアス "list" を作成します。
    エイリアスを作成した後は、コマンドラインおよびスクリプトで "Get-ChildItem" 
    の代わりに "list" を使用できます。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>set-alias list get-location
    
    説明
    -----------
    このコマンドは、"list" エイリアスを Get-Location コマンドレットと関連付けま
    す。"list" が Get-Location 以外のコマンドレットのエイリアスである場合、この
    コマンドはその関連付けを変更し、Get-Location のみのエイリアスになるようにし
    ます。
    
    このコマンドは前の例のコマンドと同じ形式を使用していますが、オプション パラ
    メーターである -Name と -Value が省略されています。パラメーター名を省略する
    場合、そのパラメーターの値はコマンドで指定されている順序に合わせる必要があり
    ます。この場合、-Name の値 ("list") は最初のパラメーター、-Value の値 ("get-
    location") は 2 番目のパラメーターにする必要があります。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>set-alias scrub remove-item -option readonly -passthru | format-list
        
    説明
    -----------
    このコマンドは、"scrub" エイリアスを Remove-Item コマンドレットと関連付けま
    す。エイリアスが削除されたり、別のコマンドレットに割り当てられたりしないよう
    にするため、"ReadOnly" オプションを指定しています。
    
    PassThru パラメーターを使用することによって、パイプラインを介して新しいエイ
    リアスを表すオブジェクトを Format-List コマンドレットに渡すよう Windows Powe
    rShell に指示しています。PassThru パラメーターが省略された場合、このコマンド
    レットの出力は (一覧形式でもその他の形式でも) 表示されません。
    
    -------------------------- 例 4 --------------------------
    
    C:\PS>Set-Alias np c:\windows\notepad.exe
    
    説明
    -----------
    このコマンドは、"np" エイリアスをメモ帳の実行可能ファイルと関連付けます。こ
    のコマンドの完了後、「np」と入力するだけで WindowsPowerShell コマンド ライン
    からメモ帳を起動できます。
    
    この例は、コマンドレット以外でも実行可能なファイルおよび要素のエイリアスが作
    成できることを示しています。
    
    このコマンドをさらに汎用的にするには、C\Windows ディレクトリを表す "Windir" 
    環境変数 (${env:windir}) を使用します。この汎用バージョンは、"set-alias np $
    {env:windir}\notepad.exe" となります。
    
    -------------------------- 例 5 --------------------------
    
    C:\PS>function CD32 {set-location c:\windows\system32}
    
    C:\PS>set-alias go cd32
    
    説明
    -----------
    これらのコマンドは、パラメーターを持つコマンド、さらには多数のコマンドで構成
    されたパイプラインにエイリアスを割り当てる方法を示しています。
    
    コマンドレットのエイリアスを作成することは可能ですが、コマンドレットとそのパ
    ラメーターで構成されるコマンドのエイリアスは作成できません。ただし、そのコマ
    ンドを関数またはスクリプト内に配置すると、便利な関数またはスクリプト名を作成
    し、その関数またはスクリプトに 1 つまたは複数のエイリアスを作成することがで
    きます。
    
    この例では、"set-location c:\windows\system32" のエイリアスを作成します。こ
    こで、"set-location" はコマンドレット、"C:\Windows\System32" は Path パラメ
    ーターの値です。
    
    これを行うため、最初のコマンドは Set-Location コマンドを含む "CD32" という名
    前の関数を作成します。
    
    2 番目のコマンドは、CD32 関数のエイリアス "go" を作成します。これで、Set-Loc
    ation コマンドを実行するには「CD32」または「go」のいずれかを入力するだけで済
    みます。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113390
    Get-Alias 
    New-Alias 
    Export-Alias 
    Import-Alias 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Set-Alias
ご利用数: 1913425
感想・要望・問い合わせは こちら