Install-Script
スクリプトをインストールします。
構文
Install-Script
[-Name] <String[]>
[-MinimumVersion <String>]
[-MaximumVersion <String>]
[-RequiredVersion <String>]
[-Repository <String[]>]
[-Scope <String>]
[-NoPathUpdate]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-Credential <PSCredential>]
[-Force]
[-AllowPrerelease]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Install-Script
[-InputObject] <PSObject[]>
[-Scope <String>]
[-NoPathUpdate]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-Credential <PSCredential>]
[-Force]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Install-Script
コマンドレットは、リポジトリからスクリプト ペイロードを取得し、ペイロードが有効な PowerShell スクリプトであることを確認し、スクリプト ファイルを指定したインストール場所にコピーします。
これは、Microsoft.PowerShell.PSResourceGet のInstall-PSResource
コマンドレットのプロキシ コマンドレットです。 詳細については、「 Install-PSResource」を参照してください。
例
例 1: スクリプトを見つけてインストールする
PS C:\> Find-Script -Repository "Local1" -Name "Required-Script2"
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
PS C:\> Find-Script -Repository "Local1" -Name "Required-Script2" | Install-Script
PS C:\> Get-Command -Name "Required-Script2"
CommandType Name Version Source
----------- ---- ------- ------
ExternalScript Required-Script2.ps1 2.0 C:\Users\pattif\Documents\WindowsPowerShell\Scripts\Required-Script2.ps1
PS C:\> Get-InstalledScript -Name "Required-Script2"
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
PS C:\> Get-InstalledScript -Name "Required-Script2" | Format-List *
Name : Required-Script2
Version : 2.5
Type : Script
Description : Description for the Required-Script2 script
Author : pattif
CompanyName :
Copyright : 2015 Microsoft Corporation. All rights reserved.
PublishedDate : 8/15/2015 12:42:39 AM
LicenseUri : http://required-script2.com/license
ProjectUri : http://required-script2.com/
IconUri : http://required-script2.com/icon
Tags : {Tag1, Tag2, Tag-Required-Script2-2.5, PSScript...}
Includes : {Function, DscResource, Cmdlet, Command}
PowerShellGetFormatVersion :
ReleaseNotes : Required-Script2 release notes
Dependencies : {}
RepositorySourceLocation : http://pattif-dev:8765/api/v2/
Repository : local1
PackageManagementProvider : NuGet
InstalledLocation : C:\Users\pattif\Documents\WindowsPowerShell\Scripts
最初のコマンドは、Local1 リポジトリから Required-Script2
という名前のスクリプトを検索し、結果を表示します。
2 番目のコマンドは、 Required-Script2
スクリプトを検索し、パイプライン 演算子を使用して Install-Script
コマンドレットに渡してインストールします。
3 番目のコマンドでは、 Get-Command
コマンドレットを使用して Required-Script2
を取得し、結果を表示します。
4 番目のコマンドでは、 Get-InstalledScript
コマンドレットを使用して Required-Script2
を取得し、結果を表示します。
5 番目のコマンドは、 Required-Script2
を取得し、パイプライン演算子を使用して Format-List
コマンドレットに渡して出力を書式設定します。
例 2: AllUsers スコープを使用してスクリプトをインストールする
PS C:\> Install-Script -Repository "Local1" -Name "Required-Script3" -Scope "AllUsers"
PS C:\> Get-InstalledScript -Name "Required-Script3"
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script3 Script local1 Description for the Required-Script3 script
PS C:\> Get-InstalledScript -Name "Required-Script3" | Format-List *
Name : Required-Script3
Version : 2.5
Type : Script
Description : Description for the Required-Script3 script
Author : pattif
CompanyName :
Copyright : 2015 Microsoft Corporation. All rights reserved.
PublishedDate : 8/15/2015 12:42:45 AM
LicenseUri : http://required-script3.com/license
ProjectUri : http://required-script3.com/
IconUri : http://required-script3.com/icon
Tags : {Tag1, Tag2, Tag-Required-Script3-2.5, PSScript...}
Includes : {Function, DscResource, Cmdlet, Command}
PowerShellGetFormatVersion :
ReleaseNotes : Required-Script3 release notes
Dependencies : {}
RepositorySourceLocation : http://pattif-dev:8765/api/v2/
Repository : local1
PackageManagementProvider : NuGet
InstalledLocation : C:\Program Files\WindowsPowerShell\Scripts
最初のコマンドは、 Required-Script3
という名前のスクリプトをインストールし、AllUsers スコープを割り当てます。
2 番目のコマンドは、インストールされているスクリプト Required-Script3
を取得し、それに関する情報を表示します。
3 番目のコマンドは Required-Script3
を取得し、パイプライン演算子を使用して Format-List
コマンドレットに渡して出力を書式設定します。
例 3: スクリプトとその依存関係をインストールする
PS C:\> Find-Script -Repository "Local1" -Name "Script-WithDependencies2" -IncludeDependencies
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.0 Script-WithDependencies2 Script local1 Description for the Script-WithDependencies2 script
2.5 RequiredModule1 Module local1 RequiredModule1 module
2.5 RequiredModule2 Module local1 RequiredModule2 module
2.5 RequiredModule3 Module local1 RequiredModule3 module
2.5 Required-Script1 Script local1 Description for the Required-Script1 script
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
2.5 Required-Script3 Script local1 Description for the Required-Script3 script
PS C:\> Install-Script -Repository "Local1" -Name "Script-WithDependencies2"
PS C:\> Get-InstalledScript
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script1 Script local1 Description for the Required-Script1 script
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
2.5 Required-Script3 Script local1 Description for the Required-Script3 script
2.0 Script-WithDependencies2 Script local1 Description for the Script-WithDependencies2 script
PS C:\> Get-InstalledModule
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 RequiredModule1 Module local1 RequiredModule1 module
2.5 RequiredModule2 Module local1 RequiredModule2 module
2.5 RequiredModule3 Module local1 RequiredModule3 module
PS C:\> Find-Script -Repository "Local1" -Name "Required-Script*"
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script1 Script local1 Description for the Required-Script1 script
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
2.5 Required-Script3 Script local1 Description for the Required-Script3 script
PS C:\> Install-Script -Repository "Local1" -Name "Required-Script*"
PS C:\> Get-InstalledScript
Version Name Type Repository Description
------- ---- ---- ---------- -----------
2.5 Required-Script1 Script local1 Description for the Required-Script1 script
2.5 Required-Script2 Script local1 Description for the Required-Script2 script
2.5 Required-Script3 Script local1 Description for the Required-Script3 script
最初のコマンドは、 Script-WithDependencies2
という名前のスクリプトとその依存関係を Local1 リポジトリで検索し、結果を表示します。
2 番目のコマンドは、 Script-WithDependencies2
をインストールします。
3 番目のコマンドでは、 Get-InstalledScript
スクリプト コマンドレットを使用して、インストールされているスクリプトを取得し、結果を表示します。
4 番目のコマンドでは、 Get-InstalledModule
コマンドレットを使用して、インストールされているモジュールを取得し、結果を表示します。
5 番目のコマンドでは、 Find-Script
コマンドレットを使用して、名前が Required-Script
で始まるスクリプトを検索し、結果を表示します。
6 番目のコマンドは、名前が local1 リポジトリの Required-Script
で始まるスクリプトをインストールします。
最後のコマンドは、インストールされているスクリプトを取得し、結果を表示します。
パラメーター
-AcceptLicense
モジュールで必要な場合は、インストール時にライセンス契約に自動的に同意します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-AllowPrerelease
プレリリースとしてマークされたスクリプトをインストールできます。
プロキシ コマンドレットは、このパラメーターを Install-PSResource
のプレリリース パラメーターにマップします。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
指定したパッケージ プロバイダーまたはソースのスクリプトをインストールする権限を持つユーザー アカウントを指定します。
型: | PSCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Force
プロキシ コマンドレットは、 Install-PSResource
でサポートされていないため、このパラメーターを無視します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
パイプライン入力に使用されます。 InputObject に直接値を指定すると、エラーがスローされます。 パイプラインを使用して、 InputObject パラメーターを使用してオブジェクトを渡します。
型: | PSObject[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-MaximumVersion
プロキシ コマンドレットは、このパラメーターの値を使用して、Install-PSResource
の Version パラメーターで使用する NuGet バージョン検索文字列を作成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-MinimumVersion
プロキシ コマンドレットは、このパラメーターの値を使用して、Install-PSResource
の Version パラメーターで使用する NuGet バージョン検索文字列を作成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
インストールするスクリプトの名前の配列を指定します。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-NoPathUpdate
プロキシ コマンドレットは、 Install-PSResource
でサポートされていないため、このパラメーターを無視します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PassThru
PassThru パラメーターを使用する場合、Install-Script
はモジュールの PSRepositoryItemInfo オブジェクトを出力します。 これは、 Find-Script
コマンドレットから取得した情報と同じです。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Proxy
プロキシ コマンドレットは、 Install-PSResource
でサポートされていないため、このパラメーターを無視します。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ProxyCredential
プロキシ コマンドレットは、 Install-PSResource
でサポートされていないため、このパラメーターを無視します。
型: | PSCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Repository
Register-PSRepository
コマンドレットに登録されているリポジトリのフレンドリ名を指定します。 既定値は、すべての登録済みリポジトリです。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredVersion
プロキシ コマンドレットは、このパラメーターの値を使用して、Install-PSResource
の Version パラメーターで使用する NuGet バージョン検索文字列を作成します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Scope
スクリプトのインストール スコープを指定します。 有効な値は、AllUsers と CurrentUser です。
AllUsers スコープを使用すると、コンピューターのすべてのユーザーがアクセスできる場所 (つまり、 $env:ProgramFiles\WindowsPowerShell\Scripts
) にモジュールをインストールできます。
CurrentUser スコープを使用すると、モジュールを $HOME\Documents\WindowsPowerShell\Scripts
にのみインストールできるため、モジュールは現在のユーザーのみが使用できます。
スコープが定義されていない場合、既定は現在のセッションに基づいて設定されます。
- 管理者特権の PowerShell セッションの場合、 スコープ の既定値は AllUsers です。
- PowerShellGet バージョン 2.0.0 以降の管理者特権以外の PowerShell セッションの場合、スコープは CurrentUser です。
- PowerShellGet バージョン 1.6.7 以前の管理者特権以外の PowerShell セッションの場合、 スコープ は未定義であり、
Install-Module
は失敗します。
型: | String |
指定可能な値: | CurrentUser, AllUsers |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
String[]
PSObject[]
出力
メモ
重要
2020 年 4 月の時点で、PowerShell ギャラリーはトランスポート層セキュリティ (TLS) バージョン 1.0 と 1.1 をサポートしなくなりました。 TLS 1.2 以降を使用していない場合は、PowerShell ギャラリーにアクセスしようとするとエラーが表示されます。 TLS 1.2 を使用していることを確認するには、次のコマンドを使用します。
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
詳細については、PowerShell ブログの のお知らせ を参照してください。