Export-Alias

モジュール:

Microsoft.PowerShell.Utility

現在定義されているエイリアスに関する情報をファイルにエクスポートします。

構文

Export-Alias
      [-Path] <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Export-Alias
      -LiteralPath <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Export-Alias コマンドレットは、現在のセッションのエイリアスをファイルにエクスポートします。 出力ファイルが存在しない場合は、コマンドレットにより作成されます。

Export-Alias は、特定のスコープまたはすべてのスコープでエイリアスをエクスポートできます。CSV 形式で、またはセッションまたは PowerShell プロファイルに追加できる一連の Set-Alias コマンドとしてデータを生成できます。

例

例 1: エイリアスをエクスポートする

Export-Alias -Path "alias.csv"

このコマンドは、現在のエイリアス情報を現在のディレクトリ内の Alias.csv というファイルにエクスポートします。

例 2: エクスポート ファイルが既に存在しない限り、エイリアスをエクスポートする

Export-Alias -Path "alias.csv" -NoClobber

このコマンドは、現在のセッションのエイリアスを Alias.csv ファイルにエクスポートします。

NoClobber パラメーターが指定されているため、Alias.csv ファイルが現在のディレクトリに既に存在する場合、コマンドは失敗します。

例 3: ファイルにエイリアスを追加する

Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force

このコマンドは、現在のセッションのエイリアスを Alias.csv ファイルに追加します。

このコマンドでは、 Description パラメーターを使用して、ファイルの先頭にあるコメントに説明を追加します。

また、 Force パラメーターを使用して、既存のAlias.csv ファイルが読み取り専用属性を持っている場合でも上書きします。

例 4: エイリアスをスクリプトとしてエクスポートする

Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $Profile -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
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 ファイルを実行します。

パラメーター

-Append

このコマンドレットは、そのファイルの既存の内容を上書きするのではなく、指定したファイルに出力を追加することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-As

出力形式を指定します。 CSV が既定値です。 このパラメーターの有効値は、次のとおりです。

• CSV。 コンマ区切り値 (CSV) 形式です。
• スクリプティング。 エクスポートされたエイリアスごとに Set-Alias コマンドを作成します。 ファイル名拡張子 .ps1 を使用して出力ファイルに名前を付ける場合は、任意のセッションにエイリアスを追加するスクリプトとして実行できます。

型:	ExportAliasFormat
指定可能な値:	Csv, Script
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Description

エクスポートされたファイルの説明を指定します。 ファイルの先頭のヘッダー情報に続いて、説明がコメントとして表示されます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

読み取り専用の属性がファイルに設定されている場合でも、出力ファイルを上書きします。

既定では、 Export-Alias は、読み取り専用属性または非表示属性が設定されているか、コマンドで NoClobber パラメーターが使用されていない限り、警告なしでファイルを上書きします。 NoClobber パラメーターはForce パラメーターよりも優先されます。両方をコマンドで使用する場合です。

Force パラメーターは、非表示の属性でファイルを上書きするようにExport-Aliasを強制することはできません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LiteralPath

出力ファイルのパスを指定します。 Path とは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。

型:	String
Aliases:	PSPath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

名前をエクスポートするエイリアスの配列として指定します。 ワイルドカードを使用できます。

既定では、 Export-Alias はセッションまたはスコープ内のすべてのエイリアスをエクスポートします。

型:	String[]
配置:	1
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-NoClobber

コマンドで Force パラメーターを使用した場合でも、このコマンドレットによってExport-Aliasがファイルを上書きできないようにすることを示します。

NoClobber パラメーターを省略すると、Export-Aliasは、ファイルに対して読み取り専用属性が設定されていない限り、警告なしで既存のファイルを上書きします。 NoClobber は、 Force パラメーターよりも優先されます。このパラメーターを使用すると、 Export-Alias が読み取り専用属性でファイルを上書きできます。

NoClobber では、 Append パラメーターが既存のファイルにコンテンツを追加できません。

型:	SwitchParameter
Aliases:	NoOverwrite
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

出力ファイルのパスを指定します。 ワイルドカードは許可されていますが、結果のパスの値を 1 つのファイル名に解決する必要があります。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Scope

エイリアスのエクスポート元となるスコープを指定します。 このパラメーターの有効値は、次のとおりです。

• グローバル
• ローカル
• スクリプト
• 現在のスコープに対する相対的な数値 (0 からスコープの数まで(0 が現在のスコープ、1 がその親である)

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

既定では、このコマンドレットは出力を返しません。

AliasInfo

PassThru パラメーターを使用すると、このコマンドレットはエイリアスを表す AliasInfo オブジェクトを返します。

メモ

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

• epal

• Export-Aliases の結果がファイルに返されるのみです。

関連リンク

• Get-Alias
• Import-Alias
• New-Alias
• Set-Alias