Install-Module

構文

Install-Module
       [-Name] <String[]>
       [-MinimumVersion <String>]
       [-MaximumVersion <String>]
       [-RequiredVersion <String>]
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AllowPrerelease]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-Module
       [-InputObject] <PSObject[]>
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

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

これは、Microsoft.PowerShell.PSResourceGetの Get-InstalledPSResource コマンドレットのプロキシ コマンドレットです。 詳細については、「install-PSResourceの を参照してください。

例

例 1: モジュールを検索してインストールする

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

Find-Module -Name PowerShellGet | Install-Module

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

例 2: 名前でモジュールをインストールする

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

Install-Module -Name PowerShellGet

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

例 3: 最小バージョンを使用してモジュールをインストールする

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

Install-Module -Name PowerShellGet -MinimumVersion 2.0.1

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

例 4: モジュールの特定のバージョンをインストールする

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

Install-Module -Name PowerShellGet -RequiredVersion 2.0.0

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

例 5: 現在のユーザーに対してのみモジュールをインストールする

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

Install-Module -Name PowerShellGet -Scope CurrentUser

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

例 6: モジュールの最新のプレリリース バージョンをインストールする

この例では、そのバージョンがプレリリース バージョンである場合に、最新バージョンのモジュールをインストールする方法を示します。 プレリリース バージョンをインストールするには、AllowPrerelease パラメーター 必要があります。

Install-Module -Name Microsoft.PowerShell.Crescendo -AllowPrerelease

このメソッドを使用すると、利用可能な最新バージョンを取得します。 最新バージョンがプレリリースでない場合は、モジュールの最新の安定バージョンを取得します。

例 7: モジュールの特定のプレリリース バージョンをインストールする

この例では、モジュールの特定のプレリリース バージョンをインストールする方法を示します。 Find-Module コマンドレットを使用して、PowerShell ギャラリーでプレリリースバージョンのモジュールを検索できます。

プレリリース バージョンには、<version_number>-<prerelease_label>の形式があります。

Find-Module PSReadLine -AllVersions -AllowPrerelease | Select-Object -First 5

Version        Name             Repository       Description
-------        ----             ----------       -----------
2.2.6          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.5          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.4-beta1    PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.3          PSReadLine       PSGallery        Great command line editing in the PowerS…
2.2.2          PSReadLine       PSGallery        Great command line editing in the PowerS…

Install-Module -Name PSReadLine -RequiredVersion 2.2.4-beta1 -AllowPrerelease

RequiredVersion パラメーターの値には、PowerShell ギャラリーに表示されているバージョンを使用します。

パラメーター

-AcceptLicense

-AllowClobber

-AllowPrerelease

-Confirm

-Credential

-Force

-InputObject

-MaximumVersion

-MinimumVersion

-Name

-PassThru

-Proxy

-ProxyCredential

-Repository

-RequiredVersion

-Scope

-SkipPublisherCheck

-WhatIf

入力

PSRepositoryItemInfo

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

String[]

PSObject[]

String

PSCredential

Uri

出力

Microsoft.PowerShell.Commands.PSRepositoryItemInfo

PassThru パラメーターを使用する場合、Install-Module はモジュールの PSRepositoryItemInfo オブジェクトを出力します。 これは、Find-Module コマンドレットから取得するのと同じ情報です。

メモ

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

• すべてのプラットフォーム:
  • inmo

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

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

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

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

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

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

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

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

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

Install-Module は、モジュールパブリッシャーが必要に応じて指定した依存モジュールもインストールします。 パブリッシャーは、必要なモジュールとそのバージョンをモジュール マニフェストに一覧表示します。

関連リンク

• Find-Module
• Get-PSRepository
• Import-Module
• Publish-Module
• Register-PSRepository
• Uninstall-Module
• Update-Module
• about_Module