Export-Alias
現在定義されているエイリアスの情報をファイルにエクスポートします。
構文
Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Description <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Export-Alias コマンドレットは、現在のセッションのエイリアスをファイルにエクスポートします。出力ファイルが存在しない場合は、自動的に作成されます。
Export-Alias は、特定のスコープまたはすべてのスコープのエイリアスをエクスポートし、データを CSV 形式または一連の Set-Alias コマンドとして生成できます。これらはセッションまたは Windows PowerShell プロファイルに追加できます。
パラメーター
-Append
指定されたファイルの既存の内容に上書きするのではなく、ファイルに出力を追加します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-As <ExportAliasFormat>
出力形式を決定します。既定値は CSV です。
有効な値は次のとおりです。
-- CSV: コンマ区切り (CSV) 形式。
-- Script: エクスポートしたエイリアスごとに Set-Alias コマンドを作成します。出力ファイル名に .ps1 ファイル名拡張子を付けた場合は、スクリプトとして実行して、どのセッションにでもエイリアスを追加できます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Description <string>
エクスポート先のファイルに説明を追加できます。この説明は、ファイル先頭のヘッダー情報の後にコメントとして表示されます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
ファイルに読み取り専用属性が設定されている場合でも、出力ファイルを上書きします。
既定では、読み取り専用ファイルまたは隠しファイルの属性が設定されているか、コマンドに NoClobber パラメーターが使用されている場合を除いて、Export-Alias は警告なしにファイルを上書きします。コマンドに NoClobber パラメーターと Force パラメーターの両方が使用されている場合は、NoClobber パラメーターが優先されます。
Force パラメーターは、隠し属性のあるファイルの上書きを Export-Alias に強制できません。
必須 |
false |
位置 |
named |
既定値 |
Does not overwrite read-only files. |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Name <string[]>
エクスポートするエイリアスの名前を指定します。ワイルドカードを使用できます。
既定では、Export-Alias はセッションまたはスコープ内のすべてのエイリアスをエクスポートします。
必須 |
false |
位置 |
2 |
既定値 |
Export all aliases |
パイプライン入力を許可する |
true (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-NoClobber
コマンドに Force パラメーターが使用されている場合でも、Export-Alias によるファイルの上書きを防ぎます。
NoClobber パラメーターを省略した場合は、ファイルに読み取り専用属性が設定されている場合を除いて、Export-Alias は警告なしに既存のファイルを上書きします。NoClobber パラメーターは Force パラメーターより優先され、読み取り専用属性のあるファイルの上書きを Export-Alias に許可します。
NoClobber は、Append パラメーターが既存のファイルに内容を追加するのを防ぎません。
必須 |
false |
位置 |
named |
既定値 |
Overwrites read-write files. |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PassThru
エクスポートされたエイリアスを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
必須 |
false |
位置 |
named |
既定値 |
No output |
パイプライン入力を許可する |
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
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
なし パイプを使用してこのコマンドレットにオブジェクトを渡すことはできません。 |
出力 |
なし、または System.Management.Automation.AliasInfo Passthru パラメーターを使用すると、Export-Alias はエイリアスを表す System.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 Aliases" -force
説明
-----------
このコマンドは、現在のセッションのエイリアスを Alias.csv ファイルに追加します。
このコマンドは Description パラメーターを使用して、ファイルの先頭にあるコメントに説明を追加します。
また、読み取り専用属性がある場合でも、Force パラメーターを使用して既存の Alias.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-PSSession コマンドレットを使用してセッションを作成します。4 番目のコマンドは、Invoke-Command コマンドレットの FilePath パラメーターを使用して新しいセッションで Alias.ps1 ファイルを実行します。