Install-PSResource
登録済みリポジトリからリソースをインストールします。
構文
NameParameterSet (既定)
Install-PSResource
[-Name] <string[]>
[-Version <string>]
[-Prerelease]
[-Repository <string[]>]
[-Credential <pscredential>]
[-Scope <ScopeType>]
[-TemporaryPath <string>]
[-TrustRepository]
[-Reinstall]
[-Quiet]
[-AcceptLicense]
[-NoClobber]
[-SkipDependencyCheck]
[-AuthenticodeCheck]
[-RuntimeIdentifier <string>]
[-TargetFramework <string>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectParameterSet
Install-PSResource
[-InputObject] <PSResourceInfo[]>
[-Repository <string[]>]
[-Credential <pscredential>]
[-Scope <ScopeType>]
[-TemporaryPath <string>]
[-TrustRepository]
[-Reinstall]
[-Quiet]
[-AcceptLicense]
[-NoClobber]
[-SkipDependencyCheck]
[-AuthenticodeCheck]
[-RuntimeIdentifier <string>]
[-TargetFramework <string>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RequiredResourceFileParameterSet
Install-PSResource
-RequiredResourceFile <string>
[-Credential <pscredential>]
[-Scope <ScopeType>]
[-TemporaryPath <string>]
[-TrustRepository]
[-Reinstall]
[-Quiet]
[-AcceptLicense]
[-NoClobber]
[-SkipDependencyCheck]
[-AuthenticodeCheck]
[-RuntimeIdentifier <string>]
[-TargetFramework <string>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RequiredResourceParameterSet
Install-PSResource
-RequiredResource <Object>
[-Credential <pscredential>]
[-Scope <ScopeType>]
[-TemporaryPath <string>]
[-TrustRepository]
[-Reinstall]
[-Quiet]
[-AcceptLicense]
[-NoClobber]
[-SkipDependencyCheck]
[-AuthenticodeCheck]
[-RuntimeIdentifier <string>]
[-TargetFramework <string>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
このコマンドレットは、登録済みのリポジトリからマシン上のインストール パスにリソースをインストールします。 既定では、コマンドレットはオブジェクトを返しません。 その他のパラメーターを使用すると、リソースのリポジトリ、スコープ、バージョンを指定し、ライセンス プロンプトを抑制できます。
このコマンドレットは、PowerShellGet v2 の Install-Module コマンドレットと Install-Script コマンドレット 関数を組み合わせたものになります。
Install-PSResource は、新しくインストールされたモジュールを現在のセッションに読み込むことはありません。 更新されたモジュールを使用するには、新しいバージョンをインポートするか、新しいセッションを開始する必要があります。 詳細については、「Import-Module」を参照してください。
注
Install-PSResource は、NuGet v3 プロトコルを使用するリポジトリから依存リソースをインストールしません。 依存リソースは個別にインストールする必要があります。 この機能は今後のリリースで追加する予定です。
PSResourceGet v1.3.0-preview2からは、2つの新機能が追加されました:
プラットフォームおよびターゲットフレームワークの名称認識
デフォルトでは、
Install-PSResourceコマンドレットはリソースのプラットフォーム固有およびターゲットフレームワーク固有のコンポーネントのみをインストールします。 この新しい動作により、インストールされたリソースのサイズが削減され、ディスク容量の使用が減ります。 このリリースでは、インストール時にプラットフォームとターゲットフレームワークを指定するための2つの新しいパラメータ、**RuntimeIdentifier **と TargetFrameworkも追加されました。$PSUserContentPathのサポートPSResourceGetは現在PowerShellの自動変数
$PSUserContentPathを尊重しています。 この自動変数は将来のPowerShell 7.7.0リリースで追加される予定です。 PowerShellはこの変数にCurrentUserコンテンツの解決済みパスを入力します。$PSUserContentPathに利用可能な文字列が含まれている場合、PSResourceGetはそのパスの下にCurrentUserモジュールとスクリプトをインストールします。 変数が利用不可または空の場合、PSResourceGetは既存のプラットフォーム固有の CurrentUser パスを保持します。 AllUsersモジュールとスクリプトの位置は変更されていません。 PSResourceGetは環境変数を解析したり、直接powershell.config.jsonしたりしません。 PowerShellは設定優先順位と環境変数の拡張を所有し、解決されたセッション値を$PSUserContentPathを通じて公開します。
例
例 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 |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AuthenticodeCheck
Windows で Authenticode 署名とカタログ ファイルを検証します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
リポジトリにアクセスするときに使用される省略可能な資格情報。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
パイプライン入力に使用されます。
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | 親リソース |
パラメーター セット
InputObjectParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
インストールする 1 つ以上のリソースの名前。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-NoClobber
コンピューターに既に存在するコマンドレットを含むパッケージをインストールできないようにします。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
指定すると、保存されたリソースの PSResourceInfo オブジェクトが出力されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Prerelease
指定すると、返される検索結果にプレリリース バージョンが含まれます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Isプレリリース |
パラメーター セット
NameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Quiet
インストールの進行状況バーを非表示にします。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Reinstall
最新バージョンが既にインストールされている場合でも、モジュールの最新バージョンをインストールします。 インストールされているバージョンが上書きされます。 これにより、モジュールの破損したインストールを修復できます。
古いバージョンのモジュールがインストールされている場合、新しいバージョンは新しいバージョン固有のフォルダに並べてインストールされます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Repository
検索する 1 つ以上のリポジトリ名を指定します。 指定しない場合、パッケージを含むリポジトリが見つかるまで、すべての登録済みリポジトリが優先順位 (最も高い順) で検索に含まれます。 リポジトリは優先度で並べ替えられた後、名前で並べ替えられます。 優先度 値が低いほど優先順位が高くなります。
複数のリポジトリ間でリソースを検索する場合、PSResourceGet コマンドレットは、この並べ替え順序を使用してリポジトリを検索します。
Install-PSResource は、並べ替えられたリポジトリの一覧から最初に一致するパッケージをインストールします。
このパラメーターは、* ワイルドカード文字をサポートします。 複数のリポジトリを指定する場合は、すべての名前にワイルドカード文字を含めるか省略する必要があります。 ワイルドカードの有無にかかわらず、名前の組み合わせを指定することはできません。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
InputObjectParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RequiredResource
インストールするリソースを指定するハッシュテーブルまたは JSON 文字列。 ワイルドカード文字は使用できません。 ファイル形式の説明については、「NOTES」セクションを参照してください。
パラメーターのプロパティ
| 型: | Object |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RequiredResourceParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RequiredResourceFile
インストールするリソースを指定する .psd1 または .json へのパス。 ワイルドカード文字は使用できません。 ファイル形式の説明については、「NOTES」セクションを参照してください。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RequiredResourceFileParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RuntimeIdentifier
プラットフォーム固有の資産をフィルタリングするためのランタイム識別子(RID)を指定します。 指定されている場合、コマンドは自動検出プラットフォームではなく、このRIDに一致するランタイムアセットのみをインストールします。 これはクロスプラットフォーム展開シナリオ、例えばWindowsからLinuxパッケージを作成する場合に利用できます。 このコマンドは、.NET RIDカタログから以下のRID値をサポートしています:
linux-armlinux-arm64linux-musl-arm64linux-musl-x64linux-x64osx-arm64osx-x64win-arm64win-x64win-x86
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Scope
インストール スコープを指定します。 受け入れられる値は次のとおりです。
CurrentUserAllUsers
既定のスコープは CurrentUserであり、インストールに昇格は必要ありません。
AllUsers スコープは、コンピューターのすべてのユーザーがアクセスできる場所にモジュールをインストールします。 例えば次が挙げられます。
$env:ProgramFiles\PowerShell\Modules
CurrentUser は、コンピューターの現在のユーザーのみがアクセスできる場所にモジュールをインストールします。 例えば次が挙げられます。
$home\Documents\PowerShell\Modules
パラメーターのプロパティ
| 型: | Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType |
| 規定値: | None |
| 指定可能な値: | CurrentUser, AllUsers |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipDependencyCheck
リソースの依存関係のチェックをスキップします。 見つかったリソースのみがインストールされます。 見つかったリソースのリソースはインストールされません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TargetFramework
フォルダフィルタリングのために選択するターゲットフレームワークモニカー(TFM)を指定 lib/ 。 指定されている場合、コマンドは自動検出フレームワークではなく、このTFMに一致する lib/ アセットのみをインストールします。
これはクロスプラットフォーム展開シナリオ、例えばWindowsからLinuxパッケージを作成する場合に利用できます。 コマンドは以下のTFM値をサポートしています:
net48net6.0net7.0net8.0net9.0net10.0netstandard2.0netstandard2.1
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TemporaryPath
実際のインストールの前にリソースを一時的にインストールするパスを指定します。 一時パスが指定されていない場合、リソースは現在のユーザーの一時フォルダーに一時的にインストールされます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrustRepository
リポジトリを信頼するためのプロンプトを表示しない。 リポジトリを信頼するように求めるプロンプトは、リポジトリが信頼済みとして構成されていない場合にのみ発生します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Version
返されるリソースのバージョンを指定します。 値には、NuGet のバージョン管理構文を使用して、正確なバージョンまたはバージョン範囲を指定できます。
NuGet のバージョン範囲の詳細については、「パッケージのバージョン管理
PowerShellGet では、NuGet のバージョン範囲のドキュメントに記載されている 最小包括バージョン 以外のすべてをサポートしています。 バージョンとして 1.0.0.0 を使用しても、バージョン 1.0.0.0 以降 (最小包括範囲) は生成されません。 代わりに、値は必要なバージョンと見なされます。 最小包括範囲を検索するには、バージョン範囲として [1.0.0.0, ] を使用します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
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を参照してください。
