Install-Module

Install-Module
    [-Name] <string[]>
    [-MinimumVersion <version>]
    [-MaximumVersion <version>]
    [-RequiredVersion <version>]
    [-Repository <string[]>]
    [-Scope <string>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Install-Module
    [-InputObject] <psobject[]>
    [-Scope <string>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Install-Module コマンドレットは、オンライン リポジトリから、指定された条件を満たす 1 つ以上のモジュールを取得します。 このコマンドレットは、検索結果が有効なモジュールであることを確認し、モジュール フォルダーをインストール場所にコピーします。 インストールしたモジュールは、インストール後に自動的にインポートされません。 インストールされているモジュールは、指定したモジュールの最小、最大、正確なバージョンに基づいてフィルター処理できます。

インストールされているモジュールの名前またはバージョンが同じか、または既存のモジュールにコマンドが含まれている場合は、警告メッセージが表示されます。 モジュールをインストールし、警告をオーバーライドすることを確認したら、 -Force パラメーターを使用します。 リポジトリの設定によっては、モジュールのインストールを続行するためのプロンプトに答える必要がある場合があります。

これらの例では、登録されている唯一のリポジトリとして PowerShell ギャラリー を使用します。 Get-PSRepository には、登録済みのリポジトリが表示されます。 複数の登録済みリポジトリがある場合は、 -Repository パラメーターを使用してリポジトリの名前を指定します。

この例では、リポジトリ内のモジュールを検索し、モジュールをインストールします。

Find-Module -Name PowerShellGet | Install-Module

Find-Moduleでは、Name パラメーターを使用して PowerShellGet モジュールを指定します。 既定では、モジュールの最新バージョンがリポジトリからダウンロードされます。 オブジェクトは、パイプラインから Install-Module コマンドレットに送信されます。 Install-Module は、 $env:ProgramFiles\WindowsPowerShell\Modules内のすべてのユーザーのモジュールをインストールします。

この例では、 PowerShellGet モジュールの最新バージョンがインストールされています。

Install-Module -Name PowerShellGet

Install-Moduleでは、Name パラメーターを使用して PowerShellGet モジュールを指定します。 既定では、モジュールの最新バージョンがリポジトリからダウンロードされ、インストールされます。

この例では、 PowerShellGet モジュールの最小バージョンがインストールされています。 MinimumVersion パラメーターは、インストールする必要があるモジュールの最小バージョンを指定します。 新しいバージョンのモジュールが使用可能な場合は、そのバージョンがダウンロードされ、すべてのユーザーにインストールされます。

Install-Module -Name PowerShellGet -MinimumVersion 2.0.1

Install-Moduleでは、Name パラメーターを使用して PowerShellGet モジュールを指定します。 MinimumVersion パラメーターは、バージョン 2.0.1 がリポジトリからダウンロードされ、インストールされることを指定します。 バージョン 2.0.4 を使用できるため、そのバージョンはすべてのユーザーに対してダウンロードおよびインストールされます。

この例では、 PowerShellGet モジュールの特定のバージョンがインストールされています。

Install-Module -Name PowerShellGet -RequiredVersion 2.0.0

Install-Moduleでは、Name パラメーターを使用して PowerShellGet モジュールを指定します。 RequiredVersion パラメーターは、すべてのユーザーに対してバージョン 2.0.0 をダウンロードしてインストールすることを指定します。

この例では、現在のユーザーに対してのみ、最新バージョンのモジュールをダウンロードしてインストールします。

Install-Module -Name PowerShellGet -Scope CurrentUser

Install-Moduleでは、Name パラメーターを使用して PowerShellGet モジュールを指定します。 Install-Module は、最新バージョンの PowerShellGet を 現在のユーザーのディレクトリ ( $home\Documents\WindowsPowerShell\Modules) にダウンロードしてインストールします。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

Find-Moduleは、パイプラインをに送信できる Install-Module オブジェクトを作成します。

Install-Module は、PowerShell 5.0 以降のリリース、Windows 7 または Windows 2008 R2 以降のリリースの Windows で実行されます。

セキュリティのベスト プラクティスとして、コマンドレットまたは関数を初めて実行する前に、モジュールのコードを評価します。 悪意のあるコードを含むモジュールの実行を防止するため、インストール後にインストール済みモジュールが自動的にインポートされません。

Name パラメータで指定されたモジュール名がリポジトリに存在しない場合、Install-Module はエラーを返します。

複数のモジュールをインストールするには、 Name パラメーターを使用し、モジュール名のコンマ区切りの配列を指定します。 複数のモジュール名を指定した場合、 MinimumVersion、 MaximumVersion、または RequiredVersion は使用できません。 Find-Moduleは、パイプラインをに送信できる Install-Module オブジェクトを作成します。 パイプラインは、1 つのコマンドでインストールする複数のモジュールを指定するもう 1 つの方法です。

既定では、 AllUsers のスコープのモジュールは $env:ProgramFiles\WindowsPowerShell\Modulesにインストールされます。 既定では、PowerShell Desired State Configuration (DSC) リソースをインストールするときの混乱を防ぎます。

モジュールのインストールは失敗し、フォルダ内に同じ名前の .psm1、 .psd1、または .dll がない場合、インポートできません。 Force パラメーターを使用してモジュールをインストールします。

既存のモジュールのバージョンが Name パラメーターで指定された名前と一致し、 MinimumVersion または RequiredVersion パラメーターが使用されていない場合、 Install-Module はサイレントに続行しますが、モジュールはインストールされません。

既存のモジュールのバージョンが MinimumVersion パラメータの値より大きい場合、または RequiredVersion パラメータの値と等しい場合、 Install-Module はサイレントに続行しますが、モジュールはインストールされません。

既存のモジュールが MinimumVersion パラメーターまたは RequiredVersion パラメーターで指定された値と一致しない場合、 Install-Module コマンドでエラーが発生します。 たとえば、インストールされている既存のモジュールのバージョンが MinimumVersion 値より小さいか、 RequiredVersion 値と等しくない場合です。