Install-PSResource

モジュール:

Microsoft.PowerShell.PSResourceGet

登録済みリポジトリからリソースをインストールします。

構文

Install-PSResource
       [-Name] <String[]>
       [-Version <String>]
       [-Prerelease]
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <ScopeType>]
       [-TemporaryPath <String>]
       [-TrustRepository]
       [-Reinstall]
       [-Quiet]
       [-AcceptLicense]
       [-NoClobber]
       [-SkipDependencyCheck]
       [-AuthenticodeCheck]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-PSResource
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <ScopeType>]
       [-TemporaryPath <String>]
       [-TrustRepository]
       [-Reinstall]
       [-Quiet]
       [-AcceptLicense]
       [-NoClobber]
       [-SkipDependencyCheck]
       [-AuthenticodeCheck]
       [-PassThru]
       [-InputObject] <PSResourceInfo[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-PSResource
       [-Credential <PSCredential>]
       [-Scope <ScopeType>]
       [-TemporaryPath <String>]
       [-TrustRepository]
       [-Reinstall]
       [-Quiet]
       [-AcceptLicense]
       [-NoClobber]
       [-SkipDependencyCheck]
       [-AuthenticodeCheck]
       [-PassThru]
       -RequiredResourceFile <String>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-PSResource
       [-Credential <PSCredential>]
       [-Scope <ScopeType>]
       [-TemporaryPath <String>]
       [-TrustRepository]
       [-Reinstall]
       [-Quiet]
       [-AcceptLicense]
       [-NoClobber]
       [-SkipDependencyCheck]
       [-AuthenticodeCheck]
       [-PassThru]
       -RequiredResource <Object>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

このコマンドレットは、登録済みのリポジトリからマシン上のインストール パスにリソースをインストールします。 既定では、コマンドレットはオブジェクトを返しません。 その他のパラメーターを使用すると、リソースのリポジトリ、スコープ、バージョンを指定し、ライセンス プロンプトを抑制できます。

このコマンドレットは、PowerShellGet v2 の Install-Module コマンドレットと Install-Script コマンドレット 関数を組み合わせたものになります。

Install-PSResource は、新しくインストールされたモジュールを現在のセッションに読み込むことはありません。 更新されたモジュールを使用するには、新しいバージョンをインポートするか、新しいセッションを開始する必要があります。 詳細については、「Import-Module」を参照してください。

手記

Install-PSResource は、NuGet v3 プロトコルを使用するリポジトリから依存リソースをインストールしません。 依存リソースは個別にインストールする必要があります。 この機能は今後のリリースで追加する予定です。

例

例 1

Az モジュールの最新の安定版 (プレリリース以外) バージョンを PowerShell ギャラリーからインストールします。

Install-PSResource Az -Repository PSGallery

Az モジュールは、すべての Az PowerShell モジュールを依存関係として含むメタ モジュールです。 このコマンドは、Az モジュールとそのすべての依存関係をインストールします。

例 2

バージョン と 7.3.0の間に、Az 8.3.0 をインストールします。

Install-PSResource Az -Version '[7.3.0, 8.3.0]'

例 3

Az モジュールの最新の安定バージョンをインストールします。 再インストール パラメーターを使用すると、コマンドレットは以前にインストールしたバージョンに対して書き込みます。

Install-PSResource Az -Reinstall

例 4

psd1 ファイルで指定された PSResource をインストールします。

Install-PSResource -RequiredResourceFile myRequiredModules.psd1

例 5

ハッシュテーブルで指定された PSResource をインストールします。

Install-PSResource -RequiredResource  @{
    TestModule = @{
        version = '[0.0.1,1.3.0]'
        repository = 'PSGallery'
      }
    TestModulePrerelease = @{
        version = '[0.0.0,0.0.5]'
        repository = 'PSGallery'
        prerelease = 'true'
    }
    TestModule99 = @{}
}

パラメーター

-AcceptLicense

リソースがライセンス契約に同意する要求を受け入れる必要があることを指定します。 これにより、ユーザーが使用許諾契約書に同意することをモジュールが要求した場合のプロンプトが表示されなくなります。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AuthenticodeCheck

Windows で Authenticode 署名とカタログ ファイルを検証します。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Credential

リポジトリにアクセスするときに使用される省略可能な資格情報。

型:	PSCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

パイプライン入力に使用されます。

型:	Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo[]
Aliases:	ParentResource
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

インストールする 1 つ以上のリソースの名前。

型:	String[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NoClobber

コンピューターに既に存在するコマンドレットを含むパッケージをインストールできないようにします。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PassThru

指定すると、保存されたリソースの PSResourceInfo オブジェクトが出力されます。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Prerelease

指定すると、返される検索結果にプレリリース バージョンが含まれます。

型:	SwitchParameter
Aliases:	IsPrerelease
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Quiet

インストールの進行状況バーを非表示にします。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Reinstall

最新バージョンが既にインストールされている場合でも、モジュールの最新バージョンをインストールします。 インストールされているバージョンが上書きされます。 これにより、モジュールの破損したインストールを修復できます。

以前のバージョンのモジュールがインストールされている場合、新しいバージョンは、新しいバージョン固有のフォルダーに並べてインストールされます。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Repository

検索する 1 つ以上のリポジトリ名を指定します。 指定しない場合、パッケージを含むリポジトリが見つかるまで、すべての登録済みリポジトリが優先順位 (最も高い順) で検索に含まれます。 リポジトリは優先度で並べ替えられた後、名前で並べ替えられます。 優先度 値が低いほど優先順位が高くなります。

複数のリポジトリ間でリソースを検索する場合、PSResourceGet コマンドレットは、この並べ替え順序を使用してリポジトリを検索します。 Install-PSResource は、並べ替えられたリポジトリの一覧から最初に一致するパッケージをインストールします。

このパラメーターは、* ワイルドカード文字をサポートします。 複数のリポジトリを指定する場合は、すべての名前にワイルドカード文字を含めるか省略する必要があります。 ワイルドカードの有無にかかわらず、名前の組み合わせを指定することはできません。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-RequiredResource

インストールするリソースを指定するハッシュテーブルまたは JSON 文字列。 ワイルドカード文字は使用できません。 ファイル形式の説明については、「NOTES」セクションを参照してください。

型:	Object
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RequiredResourceFile

インストールするリソースを指定する .psd1 または .json へのパス。 ワイルドカード文字は使用できません。 ファイル形式の説明については、「NOTES」セクションを参照してください。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Scope

インストール スコープを指定します。 指定できる値は次のとおりです。

• CurrentUser
• AllUsers

既定のスコープは CurrentUserであり、インストールに昇格は必要ありません。

AllUsers スコープは、コンピューターのすべてのユーザーがアクセスできる場所にモジュールをインストールします。 例えば：

• $env:ProgramFiles\PowerShell\Modules

CurrentUser は、コンピューターの現在のユーザーのみがアクセスできる場所にモジュールをインストールします。 例えば：

• $home\Documents\PowerShell\Modules

型:	Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType
指定可能な値:	CurrentUser, AllUsers
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SkipDependencyCheck

リソースの依存関係のチェックをスキップします。 見つかったリソースのみがインストールされます。 見つかったリソースのリソースはインストールされません。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TemporaryPath

実際のインストールの前にリソースを一時的にインストールするパスを指定します。 一時パスが指定されていない場合、リソースは現在のユーザーの一時フォルダーに一時的にインストールされます。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TrustRepository

リポジトリを信頼するためのプロンプトを表示しない。 リポジトリを信頼するように求めるプロンプトは、リポジトリが信頼済みとして構成されていない場合にのみ発生します。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Version

返されるリソースのバージョンを指定します。 値には、NuGet のバージョン管理構文を使用して、正確なバージョンまたはバージョン範囲を指定できます。

NuGet のバージョン範囲の詳細については、「パッケージのバージョン管理 参照してください。

PowerShellGet では、NuGet のバージョン範囲のドキュメントに記載されている 最小包括バージョン 以外のすべてをサポートしています。 バージョンとして 1.0.0.0 を使用しても、バージョン 1.0.0.0 以降 (最小包括範囲) は生成されません。 代わりに、値は必要なバージョンと見なされます。 最小包括範囲を検索するには、バージョン範囲として [1.0.0.0, ] を使用します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String[]

String

SwitchParameter

Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo[]

出力

Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo

既定では、コマンドレットはオブジェクトを返しません。 PassThru パラメーターを使用すると、コマンドレットは、保存されたリソースの PSResourceInfo オブジェクトを出力します。

メモ

モジュールは、isres を Install-PSResourceのエイリアスとして定義します。

RequiredResource および requiredResourceFile パラメーターは、特定の条件に一致する PSResource オブジェクト 検索するために使用されます。 ハッシュテーブルまたは JSON オブジェクトを使用して検索条件を指定できます。 RequiredResourceFile パラメーターの場合、ハッシュテーブルは .psd1 ファイルに格納され、JSON オブジェクトは .json ファイルに格納されます。 詳細については、about_PSResourceGetを参照してください。

関連リンク

• パッケージのバージョン管理
• Uninstall-PSResource