次の方法で共有


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 スクリプトであることを確認し、スクリプト ファイルを指定したインストール場所にコピーします。

に対して動作する既定のリポジトリInstall-Scriptは、、Set-PSRepositoryUnregister-PSRepository、および Get-PSRepository コマンドレットをRegister-PSRepository使用して構成できます。 複数のリポジトリに対して操作する場合は、 Install-Script 指定した検索条件 (NameMinimumVersion、または MaximumVersion) に一致する最初のスクリプトを最初のリポジトリからエラーなしでインストールします。

例 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 番目のコマンドでは、script コマンドレットを Get-InstalledScript 使用してインストールされているスクリプトを取得し、結果を表示します。

4 番目のコマンドでは、 コマンドレットを Get-InstalledModule 使用して、インストールされているモジュールを取得し、結果を表示します。

5 番目のコマンドでは、 コマンドレットを Find-Script 使用して、名前がで始まる Required-Script スクリプトを検索し、結果を表示します。

6 番目のコマンドは、Local1 リポジトリで名前が で Required-Script 始まるスクリプトをインストールします。

最後のコマンドは、インストールされているスクリプトを取得し、結果を表示します。

パラメーター

-AcceptLicense

モジュールで必要な場合は、インストール中にライセンス契約に自動的に同意します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowPrerelease

プレリリースとしてマークされたスクリプトをインストールできます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

指定したパッケージ プロバイダーまたはソースのスクリプトをインストールする権限を持つユーザー アカウントを指定します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

パイプライン入力に使用されます。 InputObject に直接指定された値の場合、エラーがスローされます。 パイプラインを使用して、 InputObject パラメーターを使用してオブジェクトを渡します。

Type:PSObject[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaximumVersion

インストールする 1 つのスクリプトの最大バージョンを指定します。 複数のスクリプトをインストールしようとしている場合は、このパラメーターを追加できません。 MaximumVersion パラメーターと RequiredVersion パラメーターは相互に排他的です。同じコマンドで両方のパラメーターを使用することはできません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MinimumVersion

インストールする 1 つのスクリプトの最小バージョンを指定します。 複数のスクリプトをインストールしようとしている場合は、このパラメーターを追加できません。 MinimumVersion パラメーターと RequiredVersion パラメーターは相互に排他的です。同じコマンドで両方のパラメーターを使用することはできません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

インストールするスクリプトの名前の配列を指定します。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoPathUpdate

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Proxy

インターネット リソースに直接接続するのではなく、要求のプロキシ サーバーを指定します。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProxyCredential

Proxy パラメーターに指定したプロキシ サーバーを使用するアクセス許可を持つユーザー アカウントを指定します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Repository

コマンドレットに登録されているリポジトリのフレンドリ名を Register-PSRepository 指定します。 既定値は、すべての登録済みリポジトリです。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredVersion

インストールするスクリプトの正確なバージョン番号を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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 、失敗します。
Type:String
Accepted values:CurrentUser, AllUsers
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String[]

PSObject[]

String

Uri

PSCredential

出力

Object

メモ

重要

2020 年 4 月時点で、PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 および 1.1 がサポートされなくなります。 TLS 1.2 以降を使用していない場合、PowerShell ギャラリーにアクセスしようとするとエラーが発生します。 次のコマンドを使用して、確実に TLS 1.2 を使用するようにします。

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

詳細については、PowerShell ブログのお知らせを参照してください。