次の方法で共有

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, LP
配置: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

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

  • Global
  • Local
  • Script
  • 現在のスコープに対する相対的な数値 (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 オブジェクトを返します。

メモ

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

  • すべてのプラットフォーム:
    • epal
  • ファイルにのみ Export-Aliases できます。