about_Environment_Variables

[アーティクル]
05/09/2024

簡単な説明

PowerShell で環境変数にアクセスして管理する方法について説明します。

環境変数には、オペレーティングシステムやその他のプログラムで使用されるデータが格納されます。 PowerShell では、次の環境変数が作成されます。

POWERSHELL_TELEMETRY_OPTOUT
POWERSHELL_DISTRIBUTION_CHANNEL
POWERSHELL_UPDATECHECK
PSExecutionPolicyPreference
PSModulePath
PSModuleAnalysisCachePath
PSDisableModuleAnalysisCacheCleanup

これらの変数の詳細については、この記事の PowerShell 環境変数を参照してください。

長い説明

PowerShell は、サポートされている任意のオペレーティングシステムプラットフォームで環境変数にアクセスして管理できます。 PowerShell 環境プロバイダーを使用すると、現在のコンソールで環境変数を取得、追加、変更、クリア、および削除できます。

注意

Windows とは異なり、macOS と Linux の環境変数の名前では大文字と小文字が区別されます。たとえば、 $env:Path と $env:PATH は、Windows 以外のプラットフォームでは異なる環境変数です。

環境変数は、PowerShell の他の種類の変数とは異なり、常に文字列として格納されます。また、他の変数とは異なり、ローカルバックグラウンドジョブやモジュールメンバーが実行されるセッションなど、子プロセスによって継承されます。これにより、環境変数は、親プロセスと子プロセスの両方で必要な値を格納するのに適しています。

Windows では、環境変数は次の 3 つのスコープで定義できます。

マシン (またはシステム) スコープ
ユーザースコープ
プロセススコープ

プロセス スコープには、現在のプロセスまたは PowerShell セッションで使用できる環境変数が含まれています。この変数の一覧は親プロセスから継承され、 Machine スコープと User スコープ内の変数から構築されます。

PowerShell で環境変数を変更すると、変更は現在のセッションにのみ影響します。この動作は、Windows コマンドシェルの set コマンドと UNIX ベースの環境でのコマンドの setenv 動作に似ています。マシンスコープまたはユーザースコープの値を変更するには、 System.Environment クラスのメソッドを使用する必要があります。

マシンスコープ変数を変更するには、アクセス許可も必要です。十分なアクセス許可なしで値を変更しようとすると、コマンドは失敗し、PowerShell にエラーが表示されます。

PowerShell には、環境変数を使用および管理するためのさまざまな方法が用意されています。

変数の構文
環境プロバイダーと Item コマンドレット
.NET System.Environment クラス

変数構文を使用する

環境変数の値は、次の構文で表示および変更できます。

$Env:<variable-name>

たとえば、環境変数の値を表示するには、次のようにします WINDIR 。

$Env:windir

C:\Windows

この構文では、ドル記号 ($) は変数を示し、ドライブ名 (Env:) は環境変数の後に変数名 (windir) を示します。

環境変数の値は、次の構文で作成および更新できます。

$Env:<variable-name> = "<new-value>"

たとえば、環境変数を作成するには、次のようにします Foo 。

$Env:Foo = 'An example'

環境変数は常に文字列であるため、文字列を含む他の変数と同様に使用できます。例:

"The 'Foo' environment variable is set to: $Env:Foo"
$Env:Foo += '!'
$Env:Foo

The 'Foo' environment variable is set to: An example

An example!

PowerShell では、環境変数を空の文字列に設定することはできません。環境変数をに $null 設定するか、空の文字列を設定すると、現在のセッションから削除されます。例:

$Env:Foo = ''
$Env:Foo | Get-Member -MemberType Properties

Get-Member : You must specify an object for the Get-Member cmdlet.
At line:1 char:12
+ $env:foo | Get-Member
+            ~~~~~~~~~~
    + CategoryInfo          : CloseError: (:) [Get-Member], InvalidOperationException
    + FullyQualifiedErrorId : NoObjectInGetMember,Microsoft.PowerShell.Commands.GetMemberCommand

Get-Member 環境変数が削除されたため、エラーが返されました。空の文字列で使用すると、エラーが返されないことがわかります。

'' | Get-Member -MemberType Properties

   TypeName: System.String

Name   MemberType Definition
----   ---------- ----------
Length Property   int Length {get;}

PowerShell の変数の詳細については、「 about_Variables」を参照してください。

環境プロバイダーと Item コマンドレットを使用する

PowerShell の環境プロバイダーは、ファイルシステムドライブに似た形式で環境変数を操作するためのインターフェイスを提供します。 PowerShell で環境変数と値を取得、追加、変更、クリア、削除できます。

たとえば、の値Barを使用してFoo環境変数を作成するには、

New-Item -Path Env:\Foo -Value 'Bar'

Name                           Value
----                           -----
Foo                            Bar

環境変数をで Copy-Itemコピーし、で環境変数の値を設定し、を使用 Set-Itemして環境変数 Get-Itemを一覧表示し、を使用 Remove-Itemして環境変数を削除することもできます。

Copy-Item -Path Env:\Foo -Destination Env:\Foo2 -PassThru
Set-Item -Path Env:\Foo2 -Value 'BAR'
Get-Item -Path Env:\Foo*
Remove-Item -Path Env:\Foo* -Verbose

Name                           Value
----                           -----
Foo2                           Bar

Name                           Value
----                           -----
Foo2                           BAR
Foo                            Bar

VERBOSE: Performing the operation "Remove Item" on target "Item: Foo2".
VERBOSE: Performing the operation "Remove Item" on target "Item: Foo".

コマンドレットを Get-ChildItem 使用して、環境変数の完全な一覧を表示します。

Get-ChildItem Env:

環境プロバイダーを使用して環境変数を管理する方法の詳細については、「about_Environment_Provider」を参照してください。

System.Environment メソッドを使用する

System.Environment クラスには、環境変数をGetEnvironmentVariable()取得および変更するためのメソッドと SetEnvironmentVariable() メソッドが用意されています。

次の例では、 Fooの値 Bar を使用して新しい環境変数を作成し、その値を返します。

[Environment]::SetEnvironmentVariable('Foo','Bar')
[Environment]::GetEnvironmentVariable('Foo')

Bar

メソッドを使用して環境変数を削除するには、 SetEnvironmentVariable() 変数の値に空の文字列を指定します。たとえば、環境変数を削除するには、次のようにします Foo 。

[Environment]::SetEnvironmentVariable('Foo','')
[Environment]::GetEnvironmentVariable('Foo')

System.Environment クラスのメソッドの詳細については、「Environment メソッド」を参照してください。

Windows で永続的な環境変数をCreateする

Windows では、環境変数を永続的に変更するための 3 つの方法があります。

プロファイルで設定する
メソッドの SetEnvironmentVariable() 使用
システムコントロールパネルを使用する

プロファイルに環境変数を設定する

PowerShell プロファイルで追加または変更した環境変数は、プロファイルを読み込む任意のセッションで使用できます。このメソッドは、サポートされている任意のプラットフォーム上の PowerShell の任意のバージョンで機能します。

たとえば、環境変数をCompanyUri作成し、フォルダーを含C:\Toolsむように環境変数をPath更新するには、PowerShell プロファイルに次の行を追加します。

$Env:CompanyUri = 'https://internal.contoso.com'
$Env:Path += ';C:\Tools'

注意

Linux または macOS では、セミコロン () の;代わりにコロン (:) を使用して、リスト内のパスの前にあるパスから新しいパスを分離します。

自動変数を使用して、PowerShell プロファイルへのパスを $PROFILE 取得できます。プロファイルの詳細については、「 about_Profiles」を参照してください。

SetEnvironmentVariable() を使用して環境変数を設定する

Windows では、メソッドの SetEnvironmentVariable() スコープを 3 番目のパラメーターとして指定して、そのスコープ内の環境変数を設定できます。マシンスコープとユーザースコープはどちらも現在のプロセスの外部で保持されるため、新しい環境変数または変更された環境変数を保存できます。

たとえば、値Barを持つ新しい環境変数Fooをマシンスコープに保存するには、次のようにします。

[Environment]::SetEnvironmentVariable('Foo', 'Bar', 'Machine')

変数の値を空の文字列に設定することで、ユーザーまたはマシンスコープから環境変数を削除できます。

[Environment]::SetEnvironmentVariable('Foo', '', 'Machine')

システムコントロールパネルで環境変数を設定する

システムコントロールパネルでは、ユーザースコープとシステム (マシン) スコープで既存の環境変数を追加または編集できます。 Windows は、これらの値をレジストリに書き込み、セッション間およびシステムの再起動間で保持されるようにします。

システムコントロールパネルを使用して Windows 上の環境変数を永続的に変更するには:

システムコントロールパネルを開きます。
[システム] を選択します。
[ システムの詳細設定] を選択します。
[ 詳細設定 ] タブに移動します。
[ 環境変数...] を選択します。
変更を行います。

Windows 以外のプラットフォームでの永続的な環境変数のCreate

Linux と macOS には、オペレーティングシステムがアプリケーションを起動する前に環境変数を設定するために使用する構成ファイルとスクリプトがあります。

PowerShell を既定の (ログイン) シェルとして実行する場合は、オペレーティングシステムでサポートされているグローバル初期化ファイルで環境変数を定義できます。たとえば Linux では、ファイルに環境変数を /etc/environment 追加したり、環境変数を設定してフォルダーに配置するスクリプトを /etc/profile.d 作成したりできます。 macOS では、環境変数をファイルに /etc/profile 追加できます。

別のシェルから PowerShell を起動する場合は、や ~/.zshrc などの~/.bashrcbash非ログインシェルで使用されるシェル固有の初期化ファイルで環境変数をzsh定義できます。

詳細については、オペレーティングシステムと既定のシェルのドキュメントを参照してください。

PowerShell 環境変数

PowerShell 機能では、環境変数を使用してユーザー設定を格納できます。これらの変数は基本設定変数と同様に機能しますが、作成されるセッションの子セッションによって継承されます。基本設定変数の詳細については、「 about_Preference_Variables」を参照してください。

環境設定を格納する環境変数には、次のものが含まれます。

POWERSHELL_TELEMETRY_OPTOUT

テレメトリをオプトアウトするには、環境変数を、、yesまたは 1にtrue設定します。詳細については、「 about_Telemetry」を参照してください。

この環境変数を有効にするには、PowerShell プロセスを開始する前に設定する必要があります。永続的な環境変数の作成については、前のセクションを参照してください。
POWERSHELL_DISTRIBUTION_CHANNEL

PowerShell 7.2 以降では、この環境変数は、PowerShell のインストールのメソッドとソースを記録するためにインストーラーパッケージによって設定されます。

この情報は、Microsoft に送信されるテレメトリデータに含まれています。ユーザーはこの値を変更しないでください。
POWERSHELL_UPDATECHECK

更新通知動作は、POWERSHELL_UPDATECHECK 環境変数を使用して変更できます。詳細については、「 about_Update_Notifications」を参照してください。

サポートされている値を次に示します。
- Off 更新通知機能をオフにする
- Default は、を定義しないのと POWERSHELL_UPDATECHECK同じです。
  - GA リリースでは、GA リリースに対する更新プログラムが通知されます
  - プレビュー/RC リリースでは、GA およびプレビューリリースに対する更新プログラムが通知されます
- LTS 長期サービス (LTS) GA リリースの更新プログラムのみを通知する
PowerShell プロセスを開始する前に、環境変数の既定値以外を設定する必要があります。永続的な環境変数の作成については、前のセクションを参照してください。
PSExecutionPolicyPreference

現在のセッションの実行ポリシーセットを格納します。この環境変数は、1 つのセッションに対して実行ポリシーを設定した場合にのみ存在します。これは、2 つの異なる方法で行うことができます。
- ExecutionPolicy パラメーターを使用してコマンドラインからセッションを開始し、セッションの実行ポリシーを設定します。
- Set-ExecutionPolicy コマンドレットを使用します。値がの Scope パラメーターを Process使用します。
- 環境変数を手動で設定します。この変数の値を変更すると、現在のプロセスの実行ポリシーが変更されます。
この情報は、Windows プラットフォームにのみ適用されます。詳細については、「about_Execution_Policies」を参照してください。
PSModulePath

環境変数には $env:PSModulePath 、モジュールとリソースを検索するために検索されるフォルダーの場所の一覧が含まれています。 Windows では、フォルダーの場所の一覧はセミコロン (;) 文字で区切られます。 Windows 以外のプラットフォームでは、コロン (:) によって環境変数内のフォルダーの場所が区切られます。

既定では、に割り当てられた $env:PSModulePath 有効な場所は次のとおりです。
- システム全体の場所: これらのフォルダーには、PowerShell に付属するモジュールが含まれています。モジュールは場所に $PSHOME\Modules 格納されます。また、これは Windows 管理モジュールがインストールされている場所です。
- ユーザーがインストールしたモジュール: ユーザーがインストールするモジュールです。 Install-Module には、現在のユーザーまたはすべてのユーザーにモジュールをインストールするかどうかを指定できる Scope パラメーターがあります。詳細については、「Install-Module」を参照してください。
  - Windows では、ユーザー固有の CurrentUser スコープの場所はフォルダーです $HOME\Documents\PowerShell\Modules 。 AllUsers スコープの場所はです$env:ProgramFiles\PowerShell\Modules。
  - Windows 以外のシステムでは、ユーザー固有の CurrentUser スコープの場所は $HOME/.local/share/powershell/Modules フォルダーです。 AllUsers スコープの場所はです/usr/local/share/powershell/Modules。
さらに、Program Files ディレクトリなどの他のディレクトリにモジュールをインストールするプログラムをセットアップすると、その場所をの $env:PSModulePath値に追加できます。

詳細については、「about_PSModulePath」を参照してください。
PSModuleAnalysisCachePath

PowerShell では、モジュールとそのコマンドレットに関するデータをキャッシュするために使用されるファイルを制御できます。キャッシュは起動時にコマンドの検索中に読み取られ、モジュールのインポート後にバックグラウンドスレッドで書き込まれます。

キャッシュの既定の場所は次のとおりです。
- Windows PowerShell 5.1: $env:LOCALAPPDATA\Microsoft\Windows\PowerShell
- PowerShell 6.0 以降: $env:LOCALAPPDATA\Microsoft\PowerShell
- Windows 以外の既定値: ~/.cache/powershell
キャッシュの既定のファイル名はです ModuleAnalysisCache。 PowerShell の複数のインスタンスがインストールされている場合、ファイル名には 16 進数のサフィックスが含まれているため、インストールごとに一意のファイル名が存在します。

注意

コマンド検出が正しく機能しない場合 (たとえば、IntelliSense に存在しないコマンドが表示されている場合)、キャッシュファイルを削除できます。次回 PowerShell を起動すると、キャッシュが再作成されます。

キャッシュの既定の場所を変更するには、PowerShell を開始する前に環境変数を設定します。値には、PowerShell がファイルの作成および書き込みアクセス許可を持つ完全なパス (ファイル名を含む) を指定する必要があります。

この環境変数の変更は、子プロセスにのみ影響します。永続的な環境変数の作成については、前のセクションを参照してください。

ファイルキャッシュを無効にするには、たとえば次のような無効な場所をこの値に設定します。
```
# `NUL` here is a special device on Windows that can't be written to,
# on non-Windows you would use `/dev/null`
$env:PSModuleAnalysisCachePath = 'NUL'
```
これにより、 NUL デバイスへのパスが設定されます。 PowerShell はパスに書き込めず、エラーは返されません。トレーサーを使用して報告されたエラーを確認できます。
```
Trace-Command -PSHost -Name Modules -Expression {
  Import-Module Microsoft.PowerShell.Management -Force
}
```
PSDisableModuleAnalysisCacheCleanup

モジュール分析キャッシュを書き出すとき、PowerShell は不要な大きなキャッシュを回避するために、存在しなくなったモジュールをチェックします。これらのチェックが望ましくない場合があります。その場合は、この環境変数の値をに 1設定して無効にすることができます。

この環境変数を設定すると、現在のプロセスの後続のクリーンアップイベントに対して有効になります。起動時にクリーンアップが無効になるようにするには、PowerShell を起動する前に環境変数を設定する必要があります。永続的な環境変数の作成については、前のセクションを参照してください。

PowerShell で使用されるその他の環境変数

パス情報

PATH

環境変数には $env:PATH 、オペレーティングシステムが実行可能ファイルを検索するフォルダーの場所の一覧が含まれています。 Windows では、フォルダーの場所の一覧はセミコロン (;) 文字で区切られます。 Windows 以外のプラットフォームでは、コロン (:) によって環境変数内のフォルダーの場所が区切られます。
PATHEXT

変数には $env:PATHEXT 、Windows が実行可能ファイルと見なすファイル拡張子の一覧が含まれています。表示されている拡張機能のいずれかを含むスクリプトファイルが PowerShell から実行されると、スクリプトは現在のコンソールまたはターミナルセッションで実行されます。ファイル拡張子が一覧にない場合、スクリプトは新しいコンソールセッションで実行されます。

別のスクリプト言語のスクリプトが現在のコンソールセッションで実行されるようにするには、スクリプト言語で使用されるファイル拡張子を追加します。たとえば、現在のコンソールで Python スクリプトを実行するには、拡張機能を .py 環境変数に追加します。 Windows で実行可能ファイルとして拡張機能を.pyサポートするには、CMD コマンドシェルのコマンドと assoc コマンドを使用してftypeファイル拡張子を登録する必要があります。 PowerShell には、ファイルハンドラーを登録するダイレクトメソッドはありません。詳細については、 ftype コマンドのドキュメントを参照してください。

PowerShell スクリプトは、常に現在のコンソールセッションで開始されます。拡張機能を追加 .PS1 する必要はありません。
XDG 変数

Windows 以外のプラットフォームでは、PowerShell では、 XDG 基本ディレクトリ仕様で定義されている次の XDG 環境変数が使用されます。
- XDG_CONFIG_HOME
- XDG_DATA_HOME
- XDG_CACHE_HOME

ターミナル機能

PowerShell 7.2 以降では、次の環境変数を使用して、出力を色分けする ANSI エスケープシーケンスなどの仮想ターミナル機能を制御できます。 ANSI エスケープシーケンスのサポートは、TERM または NO_COLOR 環境変数を使用して無効にすることができます。

用語

$env:TERM の次の値は、動作を次のように変更します。
- dumb -設定 $Host.UI.SupportsVirtualTerminal = $false
- xterm-mono -設定 $PSStyle.OutputRendering = PlainText
- xtermm -設定 $PSStyle.OutputRendering = PlainText
NO_COLOR

が存在する場合 $env:NO_COLOR は、 $PSStyle.OutputRendering が PlainText に設定されます。 NO_COLOR環境変数の詳細については、「」を参照してくださいhttps://no-color.org/。

Share via

about_Environment_Variables

簡単な説明

長い説明

変数構文を使用する

環境プロバイダーと Item コマンドレットを使用する

System.Environment メソッドを使用する

Windows で永続的な環境変数をCreateする

プロファイルに環境変数を設定する

SetEnvironmentVariable() を使用して環境変数を設定する

システムコントロールパネルで環境変数を設定する

Windows 以外のプラットフォームでの永続的な環境変数のCreate

PowerShell 環境変数

PowerShell で使用されるその他の環境変数

パス情報

ターミナル機能

こちらもご覧ください

その他のリソース

Share via

about_Environment_Variables

簡単な説明

長い説明

変数構文を使用する

環境プロバイダーと Item コマンドレットを使用する

System.Environment メソッドを使用する

Windows で永続的な環境変数をCreateする

プロファイルに環境変数を設定する

SetEnvironmentVariable() を使用して環境変数を設定する

システム コントロール パネルで環境変数を設定する

Windows 以外のプラットフォームでの永続的な環境変数のCreate

PowerShell 環境変数

PowerShell で使用されるその他の環境変数

パス情報

ターミナル機能

こちらもご覧ください

その他のリソース

システムコントロールパネルで環境変数を設定する