PowerShell Alias - epal
 記事記号:[mcAc80] 初版:2010/Dec/28

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

名前
    Export-Alias
    
概要
    現在定義されているエイリアスの情報をファイルにエクスポートします。
    
構文
    Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As 
    {Csv | Script}] [-Description <string>] [-Force] [-NoClobber] [-PassTh
    ru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
    
説明
    Export-Alias コマンドレットは、現在のセッションのエイリアスをファイルにエク
    スポートします。出力ファイルが存在しない場合は、自動的に作成されます。
    
    Export-Alias は、特定のスコープまたはすべてのスコープのエイリアスをエクスポ
    ートし、データを CSV 形式または一連の Set-Alias コマンドとして生成できます。
    これらはセッションまたは Windows PowerShell プロファイルに追加できます。

パラメーター
    -Append [<SwitchParameter>]
        指定されたファイルの既存の内容に上書きするのではなく、ファイルに出力を追
        加します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -As <ExportAliasFormat>
        出力形式を決定します。既定値は CSV です。
        
        有効な値は次のとおりです。
        
        -- CSV: コンマ区切り (CSV) 形式。
        -- Script: エクスポートしたエイリアスごとに Set-Alias コマンドを作成しま
        す。出力ファイル名に .ps1 ファイル名拡張子を付けた場合は、スクリプトとし
        て実行して、どのセッションにでもエイリアスを追加できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Description <string>
        エクスポート先のファイルに説明を追加できます。この説明は、ファイル先頭の
        ヘッダー情報の後にコメントとして表示されます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        ファイルに読み取り専用属性が設定されている場合でも、出力ファイルを上書き
        します。
        
        既定では、読み取り専用ファイルまたは隠しファイルの属性が設定されているか、
        コマンドに NoClobber パラメーターが使用されている場合を除いて、Export-Al
        ias は警告なしにファイルを上書きします。コマンドに NoClobber パラメータ
        ーと Force パラメーターの両方が使用されている場合は、NoClobber パラメー
        ターが優先されます。
        
        Force パラメーターは、隠し属性のあるファイルの上書きを Export-Alias に強
        制できません。
        
        必須                         false
        位置                         named
        既定値                       読み取り専用ファイルは上書きされません。
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string[]>
        エクスポートするエイリアスの名前を指定します。ワイルドカードを使用できま
        す。
        
        既定では、Export-Alias はセッションまたはスコープ内のすべてのエイリアスを
        エクスポートします。
        
        必須                         false
        位置                         2
        既定値                       すべてのエイリアスをエクスポートする
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -NoClobber [<SwitchParameter>]
        コマンドに Force パラメーターが使用されている場合でも、Export-Alias によ
        るファイルの上書きを防ぎます。
        
        NoClobber パラメーターを省略した場合は、ファイルに読み取り専用属性が設定
        されている場合を除いて、Export-Alias は警告なしに既存のファイルを上書きし
        ます。NoClobber パラメーターは Force パラメーターより優先され、読み取り専
        用属性のあるファイルの上書きを Export-Alias に許可します。
        
        NoClobber は、Append パラメーターが既存のファイルに内容を追加するのを防ぎ
        ません。
        
        必須                         false
        位置                         named
        既定値                       読み取り - 書き込みファイルを上書きします。
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        エクスポートされたエイリアスを表すオブジェクトを返します。既定では、この
        コマンドレットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       出力なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string>
        出力ファイルのパスを指定します。ワイルドカードは使用できますが、結果とし
        て生成されるパスの値は単一のファイル名に解決される必要があります。このパ
        ラメーターは必須です。
        
        必須                         true
        位置                         1
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Scope <string>
        エイリアスのエクスポート元となるスコープを指定します。
        
        指定可能な値は、Global、Local、Script、または現在のスコープの相対的な数値 
        (0 〜スコープの数。ここで 0 は現在のスコープを表し、1 はその親を表す) で
        す。既定値は Local です。詳細については、「about_Scopes」を参照してくださ
        い。
        
        必須                         false
        位置                         named
        既定値                       Local
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する 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 パラメーターを使用すると、Export-Alias はエイリアスを表す Syste
        m.Management.Automation.AliasInfo オブジェクトを返します。それ以外の場合、
        このコマンドレットによる出力はありません。
    
メモ
        ファイルに対する Export-Alias の実行のみが可能です。

    -------------------------- 例 1 --------------------------
    C:\PS>export-alias -path alias.csv
    
    説明
    -----------
    このコマンドは、現在のディレクトリにある Alias.csv という名前のファイルに現
    在のエイリアス情報をエクスポートします。
    
    -------------------------- 例 2 --------------------------
    C:\PS>export-alias -path alias.csv -noclobber
    
    説明
    -----------
    このコマンドは、現在のセッションのエイリアスを Alias.csv ファイルにエクスポ
    ートします。
    
    NoClobber パラメーターが指定されているため、Alias.csv ファイルが現在のディレ
    クトリに既に存在する場合はコマンドの実行に失敗します。
    
    -------------------------- 例 3 --------------------------
    C:\PS>export-alias -path alias.csv -append -description "Appended Aliase
    s" -force
    
    説明
    -----------
    このコマンドは、現在のセッションのエイリアスを Alias.csv ファイルに追加します。
    
    このコマンドは Description パラメーターを使用して、ファイルの先頭にあるコメン
    トに説明を追加します。
    
    また、読み取り専用属性がある場合でも、Force パラメーターを使用して既存の Alia
    s.csv ファイルを上書きします。
    
    -------------------------- 例 4 --------------------------
    C:\PS>export-alias -path alias.ps1 -as script
    
    C:\PS> add-content -path $profile -value (get-content alias.ps1)
    
    C:\PS> $s = new-pssession -computername Server01
    C:\PS> invoke-command -session $s -filepath .\alias.ps1
    
    説明
    -----------
    この例は、Export-Alias が生成するスクリプト ファイル形式を使用する方法を示し
    ています。
    
    最初のコマンドは、セッションのエイリアスを Alias.ps1 ファイルにエクスポートし
    ます。また、As パラメーターを Script の値と一緒に使用して、各エイリアスに Set
    -Alias コマンドが含まれているファイルを生成します。
    
    2 番目のコマンドは、Alias.ps1 ファイルのエイリアスを CurrentUser-CurrentHost 
    プロファイルに追加します (プロファイルのパスは $profile 変数に保存されていま
    す)。このコマンドは、Get-Content コマンドレットを使用して Alias.ps1 ファイル
    からエイリアスを取得し、Add-Content コマンドレットを使用してエイリアスをプロ
    ファイルに追加します。詳細については、「about_Profiles」を参照してください。
    
    3 番目と 4 番目のコマンドは、Alias.ps1 ファイルのエイリアスを Server01 コン
    ピューターのリモート セッションに追加します。3 番目のコマンドは、New-PSSess
    ion コマンドレットを使用してセッションを作成します。4 番目のコマンドは、Inv
    oke-Command コマンドレットの FilePath パラメーターを使用して新しいセッション
    で Alias.ps1 ファイルを実行します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113296
    Import-Alias 
    Get-Alias 
    New-Alias 
    Set-Alias 
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、epal
ご利用数: 1917034
感想・要望・問い合わせは こちら