Update-Module
指定したモジュールの最新バージョンをオンライン ギャラリーからダウンロードし、ローカル コンピューターにインストールします。
構文
Update-Module
[[-Name] <String[]>]
[-RequiredVersion <String>]
[-MaximumVersion <String>]
[-Credential <PSCredential>]
[-Scope <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-Force]
[-AllowPrerelease]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
コマンドレットは Update-Module
、オンライン ギャラリーからモジュールの最新バージョンをインストールします。 インストールする前に、更新プログラムの確認を求められます。 更新は、 を使用してローカル コンピューターInstall-Module
にインストールされたモジュールに対してのみインストールされます。 Update-Module
は、 $env:PSModulePath
インストールされているモジュールを検索します。
Update-Module
パラメーターが指定されていない場合は、インストールされているすべてのモジュールが更新されます。 更新するモジュールを指定するには、 Name パラメーターを使用します。 RequiredVersion パラメーターを使用して、モジュールの特定のバージョンに更新できます。
モジュールのバージョン番号を受け取るパラメーターには、バージョン番号として書式設定された文字列が必要です。
- 標準バージョン番号の形式
x.y.z
は、x、y、z は数値です - プレリリース バージョンには の形式
x.y.z-<prerelease_label>
があります。ここで、<prerelease_label>
はそのリリースに割り当てられた任意の文字列です。
インストールされているモジュールが既に最新バージョンの場合、モジュールは更新されません。 モジュールが で $env:PSModulePath
見つからない場合は、エラーが表示されます。
インストールされているモジュールを表示するには、 を使用します Get-InstalledModule
。
例
例 1: すべてのモジュールを更新する
次の使用例は、インストールされているすべてのモジュールをオンライン ギャラリーの最新バージョンに更新します。
Update-Module
例 2: モジュールを名前で更新する
次の使用例は、特定のモジュールをオンライン ギャラリーの最新バージョンに更新します。
Update-Module -Name SpeculationControl
Update-Module
は Name パラメーターを使用して、特定のモジュールである SpeculationControl を更新します。
例 3: what-if Update-Moduleの実行を表示する
この例では、what-if シナリオを実行した場合 Update-Module
の動作を示します。 コマンドは実行されません。
Update-Module -WhatIf
What if: Performing the operation "Update-Module" on target "Version '2.8.0' of module
'Carbon', updating to version '2.8.1'".
What if: Performing the operation "Update-Module" on target "Version '1.0.10' of module
'SpeculationControl', updating to version '1.0.14'".
Update-Module
は、 WhatIf パラメーターを使用して、 が実行された場合 Update-Module
に何が起こるかを表示します。
例 4: モジュールを指定したバージョンに更新する
この例では、モジュールが特定のバージョンに更新されます。 バージョンはオンライン ギャラリーに存在する必要があります。または、エラーが表示されます。
Update-Module -Name SpeculationControl -RequiredVersion 1.0.14
Update-Module
Name パラメーターを使用して、モジュールである SpeculationControl を指定します。 RequiredVersion パラメーターは、バージョン 1.0.14 を指定します。
例 5: 確認なしでモジュールを更新する
この例では、オンライン ギャラリーからモジュールを最新バージョンに更新するための確認は要求しません。 モジュールが既にインストールされている場合は、 Force パラメーターによってモジュールが再インストールされます。
Update-Module -Name SpeculationControl -Force
Update-Module
Name パラメーターを使用して、モジュールである SpeculationControl を指定します。 Force パラメーターは、ユーザーの確認を要求せずにモジュールを更新します。
パラメーター
-AcceptLicense
パッケージに必要な場合は、インストール時にライセンス契約に自動的に同意します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowPrerelease
プレリリースとしてマークされた新しいモジュールでモジュールを更新できます。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
を実行する前に確認を求めるメッセージが表示されます Update-Module
。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
モジュールを更新するアクセス許可を持つユーザー アカウントを指定します。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Force
確認を要求するプロンプトを表示せずに、指定された各モジュールの更新を強制します。 モジュールが既にインストールされている場合は、 モジュールを強制的 に再インストールします。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaximumVersion
更新する 1 つのモジュールの最大バージョンを指定します。 複数のモジュールを更新しようとしている場合は、このパラメーターを追加できません。 MaximumVersion パラメーターと RequiredVersion パラメーターは、同じコマンドでは使用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
更新する 1 つ以上のモジュールの名前を指定します。 Update-Module
は、 $env:PSModulePath
更新するモジュールを検索します。 指定したモジュール名に $env:PSModulePath
一致が見つからない場合は、エラーが発生します。
ワイルドカードはモジュール名で使用できます。 指定した名前にワイルドカード文字を追加しても、一致する文字が見つからない場合、エラーは発生しません。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-PassThru
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Proxy
インターネット リソースに直接接続するのではなく、要求のプロキシ サーバーを指定します。
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProxyCredential
Proxy パラメーターで指定されたプロキシ サーバーを使用するアクセス許可を持つユーザー アカウントを指定します。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RequiredVersion
インストールされている既存のモジュールを更新する正確なバージョンを指定します。 RequiredVersion で指定されたバージョンは、オンライン ギャラリーに存在する必要があります。または、エラーが表示されます。 1 つのコマンドで複数のモジュールが更新された場合は、 RequiredVersion を使用できません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scope
モジュールのインストール スコープを指定します。 このパラメーターに使用できる値は 、AllUsers と CurrentUser です。 スコープが指定されていない場合、更新プログラムは CurrentUser スコープにインストールされます。
AllUsers スコープには昇格されたアクセス許可が必要であり、コンピューターのすべてのユーザーがアクセスできる場所にモジュールをインストールします。
$env:ProgramFiles\PowerShell\Modules
CurrentUser は、管理者特権のアクセス許可を必要とせず、コンピューターの現在のユーザーのみがアクセスできる場所にモジュールをインストールします。
$HOME\Documents\PowerShell\Modules
スコープが定義されていない場合、既定値は PowerShellGet バージョンに基づいて設定されます。
- PowerShellGet バージョン 2.0.0 以降では、既定値は CurrentUser であり、インストールに昇格は必要ありません。
- PowerShellGet 1.x バージョンでは、既定値は AllUsers であり、インストールには昇格が必要です。
Type: | String |
Accepted values: | CurrentUser, AllUsers |
Position: | Named |
Default value: | CurrentUser |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
が実行された場合 Update-Module
の動作を示します。 コマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
String[]
出力
メモ
PowerShell には、 の次のエイリアスが Update-Module
含まれています。
- すべてのプラットフォーム:
upmo
PowerShell バージョン 6.0 以降の場合、既定のインストール スコープは常に CurrentUser です。
CurrentUser のモジュール更新プログラムでは、$HOME\Documents\PowerShell\Modules
昇格されたアクセス許可は必要ありません。 AllUsers のモジュール更新には、$env:ProgramFiles\PowerShell\Modules
昇格されたアクセス許可が必要です。
重要
2020 年 4 月時点で、PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 および 1.1 がサポートされなくなります。 TLS 1.2 以降を使用していない場合、PowerShell ギャラリーにアクセスしようとするとエラーが発生します。 次のコマンドを使用して、確実に TLS 1.2 を使用するようにします。
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
詳細については、PowerShell ブログのお知らせを参照してください。
Update-Module
は、PowerShell の PowerShell 3.0 以降のリリース、Windows 7 または Windows 2008 R2 以降のリリースの Windows で実行されます。
Name パラメーターで指定したモジュールが を使用してInstall-Module
インストールされていない場合は、エラーが発生します。
を実行すると、オンライン ギャラリーからインストールしたモジュールでのみ実行Update-Module
Install-Module
できます。
Update-Module
使用中のバイナリを更新しようとすると、Update-Module
問題のプロセスを識別するエラーが返されます。 プロセスが停止した後に再試行 Update-Module
するようにユーザーに通知されます。
関連リンク
PowerShellGet