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

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

名前
    New-Alias
    
概要
    新しいエイリアスを作成します。
    
構文
    New-Alias [-Name] <string> [-Value] <string> [-Description <string>] [-Force
    ] [-Option {None | ReadOnly | Constant | Private | AllScope}] [-PassThru] [-
    Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
    
説明
    New-Alias コマンドレットは、現在の Windows PowerShell セッションで新しいエイ
    リアスを作成します。New-Alias を使用して作成されたエイリアスは、セッションま
    たは Windows PowerShell を終了した後は保存されません。Export-Alias コマンド
    レットを使用すると、エイリアス情報をファイルに保存できます。ファイルに保存し
    たエイリアス情報は、後で Import-Alias を使用して取得できます。
    
パラメーター
    -Description <string>
        エイリアスについての説明を指定します。任意の文字列が入力可能です。説明に
        スペースが含まれる場合は、説明を二重引用符で囲みます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        設定されている場合、同じ名前のエイリアスが既に存在するときの set-alias 
        と同じように動作します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string>
        新しいエイリアスを指定します。エイリアス名には任意の英数字を使用できます
        が、数字で始めることはできません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Option <ScopedItemOptions>
        エイリアスのオプション プロパティを 1 つ以上設定します。有効な値は次のと
        おりです。
        
        -- None: オプションを設定しません (既定値)。
        
        -- ReadOnly: Force パラメーターを使用しない限り、エイリアスを変更できま
           せん。
        
        -- Constant: Force パラメーターを使用してもエイリアスを変更できません。
        
        -- Private: Scope パラメーターで指定されたスコープ内でのみ、エイリアスを
           使用できます。それ以外のスコープでは表示されません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        新しいエイリアスを表すオブジェクトを返します。既定では、このコマンドレッ
        トによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Scope <string>
        新しいエイリアスのスコープを指定します。指定可能な値は、Global、Local、S
        cript、または現在のスコープの相対的な数値 (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 パラメーターを使用すると、New-Alias は新しいエイリアスを表す Sy
        stem.Management.Automation.AliasInfo オブジェクトを生成します。それ以外
        の場合、このコマンドレットによる出力はありません。
    
メモ
        新しいエイリアスを作成するには、Set-Alias または New-Alias を使用します。
        エイリアスを変更するには、Set-Alias を使用します。エイリアスを削除するに
        は、Remove-Item を使用します。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>new-alias list get-childitem
    
    説明
    -----------
    このコマンドは、Get-ChildItem コマンドレットを表す "list" という名前のエイリ
    アスを作成します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>new-alias -name w -value get-wmiobject -description "quick wmi alias" 
    -option ReadOnly
    
    C:\PS> get-alias -name w | format-list *
    
    説明
    -----------
    このコマンドは、Get-WMIObject コマンドレットを表す "w" という名前のエイリアス
    を作成します。このエイリアス用に "quick wmi alias" という説明を作成し、読み取
    り専用にします。コマンドの最終行では、Get-Alias を使用して取得した新しいエイ
    リアスを、パイプを使用して Format-List に渡し、その情報をすべて表示します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113352
    Set-Alias 
    Get-Alias 
    Export-Alias 
    Import-Alias 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、New-Alias
ご利用数: 1862321
感想・要望・問い合わせは こちら