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 番目のコマンドでは、 コマンドレットの FilePath パラメーターを Invoke-Command 使用して、新しいセッションで Alias.ps1 ファイルを実行します。

パラメーター

-Append

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-As

出力形式を指定します。 CSV が既定値です。

有効な値は次のとおりです。

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

Type:	ExportAliasFormat
Accepted values:	Csv, Script
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

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

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

Force パラメーターは、隠し属性を使用してファイルを強制的Export-Aliasに上書きすることはできません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LiteralPath

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

Type:	String
Aliases:	PSPath
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

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

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

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-NoClobber

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

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

NoClobber では、 Append パラメーターによって既存のファイルにコンテンツが追加されるのを防ぐことはありません。

Type:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

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

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Scope

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

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

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

Type:	String
Position:	Named
Default value:	Local
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

None.

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

出力

None or System.Management.Automation.AliasInfo

Passthru パラメーターを使用すると、Export-Aliasエイリアスを表す System.Management.Automation.AliasInfo オブジェクトが返されます。 それ以外の場合、このコマンドレットによる出力はありません。

メモ

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

関連リンク

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