about_Environment_Variables

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

簡単な説明

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

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

PSExecutionPolicyPreference
PSModulePath
PSModuleAnalysisCachePath
PSDisableModuleAnalysisCacheCleanup

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

詳細な説明

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

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

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

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

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

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

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

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

変数の構文
環境プロバイダーと項目コマンドレット
.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」を参照してください。

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

PowerShell の Environment プロバイダーは、ファイルシステムドライブに似た形式で環境変数を操作するためのインターフェイスを提供します。 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:

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

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

System.Environment クラスは、環境変数を取得および変更するためのGetEnvironmentVariable()メソッドとSetEnvironmentVariable()メソッドを提供します。

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

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

Bar

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

システムコントロールパネルを開きます。
システムを選択します。
[Advanced System Settings]\(システム設定を選択します。
[ Advanced タブに移動します。
Environment Variables... を選択します。
変更を行います。

PowerShell 環境変数

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

環境設定を格納する環境変数は次のとおりです。

PSExecutionPolicyPreference

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

$env:PSModulePath環境変数には、モジュールとリソースを検索するために検索されるフォルダーの場所の一覧が含まれています。

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

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

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

キャッシュの既定の場所は次のとおりです。
- $env:LOCALAPPDATA\Microsoft\Windows\PowerShell
キャッシュの既定のファイル名は ModuleAnalysisCache。

Note

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

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

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

ファイルキャッシュを無効にするには、たとえば次のような無効な場所をこの値に設定します。
```
# `NUL` here is a special device on Windows that can't be written to
$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 では、フォルダーの場所の一覧はセミコロン (;) 文字で区切られます。
PATHEXT

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

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

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

次の方法で共有

about_Environment_Variables

簡単な説明

詳細な説明

変数構文を使用する

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

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

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

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

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

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

PowerShell 環境変数

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

パス情報

関連項目

その他のリソース

次の方法で共有

about_Environment_Variables

簡単な説明

詳細な説明

変数構文を使用する

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

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

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

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

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

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

PowerShell 環境変数

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

パス情報

関連項目

その他のリソース

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