Find-Module
指定した条件に一致するリポジトリ内のモジュールを検索します。
構文
Find-Module
[[-Name] <string[]>]
[-MinimumVersion <string>]
[-MaximumVersion <string>]
[-RequiredVersion <string>]
[-AllVersions]
[-IncludeDependencies]
[-Filter <string>]
[-Tag <string[]>]
[-Includes <string[]>]
[-DscResource <string[]>]
[-RoleCapability <string[]>]
[-Command <string[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-Repository <string[]>]
[-Credential <pscredential>]
[-AllowPrerelease]
[<CommonParameters>]説明
コマンドレットは Find-Module 、指定した条件に一致するリポジトリ内のモジュールを検索します。
Find-Module は、検出された各モジュールの PSRepositoryItemInfo オブジェクトを返します。 オブジェクトは、 などの Install-Moduleコマンドレットにパイプラインを送信できます。
リポジトリを初めて Find-Module 使用しようとすると、更新プログラムのインストールを求められる場合があります。
リポジトリ ソースがコマンドレットに Register-PSRepository 登録されていない場合は、エラーが返されます。
Find-Module は、バージョンを制限するパラメーターが使用されていない場合に、モジュールの最新バージョンを返します。 モジュールのバージョンのリポジトリのリストを取得するには、パラメーター AllVersions を使用します。
MinimumVersion パラメーターが指定されている場合は、Find-Module最小以上のモジュールのバージョンを返します。 リポジトリで使用可能な新しいバージョンがある場合は、新しいバージョンが返されます。
MaximumVersion パラメーターを指定すると、Find-Module指定したバージョンを超えない最新バージョンのモジュールが返されます。
RequiredVersion パラメーターを指定すると、Find-Module指定したバージョンと完全に一致するモジュール バージョンのみが返されます。 Find-Module は、ソース間で名前の競合が発生する可能性があるため、使用可能なすべてのモジュールを検索します。
次の例では、登録されている唯一のリポジトリとして PowerShell ギャラリー を使用します。 Get-PSRepository には、登録済みのリポジトリが表示されます。 複数のリポジトリが登録されている場合は、 パラメーターを -Repository 使用してリポジトリの名前を指定します。
例
例 1: 名前でモジュールを検索する
この例では、既定のリポジトリでモジュールを検索します。
Find-Module -Name PowerShellGet
Version Name Repository Description
------- ---- ---------- -----------
2.1.0 PowerShellGet PSGallery PowerShell module with commands for discovering...コマンドレットではFind-Module、Name パラメーターを使用して PowerShellGet モジュールを指定します。
例 2: 類似した名前のモジュールを検索する
この例では、アスタリスク (*) ワイルドカードを使用して、同じ名前のモジュールを検索します。
Find-Module -Name PowerShell*
Version Name Repository Description
------- ---- ---------- -----------
0.4.0 powershell-yaml PSGallery Powershell module for serializing and...
2.1.0 PowerShellGet PSGallery PowerShell module with commands for...
1.9 Powershell.Helper.Extension PSGallery # Powershell.Helper.Extension...
3.1 PowerShellHumanizer PSGallery PowerShell Humanizer wraps Humanizer...
4.0 PowerShellISEModule PSGallery a module that adds capability to the ISEコマンドレットではFind-Module、Name パラメーターとアスタリスク (*) ワイルドカードを使用して、PowerShell を含むすべてのモジュールを検索します。
例 3: 最小バージョンでモジュールを検索する
この例では、モジュールの最小バージョンを検索します。 リポジトリにモジュールの新しいバージョンが含まれている場合は、新しいバージョンが返されます。
Find-Module -Name PowerShellGet -MinimumVersion 1.6.5
Version Name Repository Description
------- ---- ---------- -----------
2.1.0 PowerShellGet PSGallery PowerShell module with commands for discovering...コマンドレットではFind-Module、Name パラメーターを使用して PowerShellGet モジュールを指定します。 MinimumVersion はバージョン 1.6.5 を指定します。 Find-Module は PowerShellGet バージョン 2.1.0 を返します。これは、最小バージョンを超え、最新バージョンであるためです。
例 4: 特定のバージョンでモジュールを検索する
次の使用例は、モジュールの特定のバージョンを表す オブジェクトを返します。 指定したバージョンが見つからない場合は、エラーが返されます。
Find-Module -Name PowerShellGet -RequiredVersion 1.6.5
Version Name Repository Description
------- ---- ---------- -----------
1.6.5 PowerShellGet PSGallery PowerShell module with commands for discovering...コマンドレットではFind-Module、Name パラメーターを使用して PowerShellGet モジュールを指定します。 RequiredVersion パラメーターは、バージョン 1.6.5 を指定します。
例 5: 特定のリポジトリでモジュールを検索する
この例では、 Repository パラメーターを使用して、特定のリポジトリ内のモジュールを検索します。
Find-Module -Name PowerShellGet -Repository PSGallery
Version Name Repository Description
------- ---- ---------- -----------
2.1.0 PowerShellGet PSGallery PowerShell module with commands for discovering...コマンドレットではFind-Module、Name パラメーターを使用して PowerShellGet モジュールを指定します。 Repository パラメーターは、PSGallery リポジトリを検索するように指定します。
例 6: 複数のリポジトリでモジュールを検索する
この例では、 を Register-PSRepository 使用してリポジトリを指定します。 Find-Module では、リポジトリを使用してモジュールを検索します。
Register-PSRepository -Name MySource -SourceLocation https://www.myget.org/F/powershellgetdemo/
Find-Module -Name Contoso* -Repository PSGallery, MySource
Repository Version Name Description
---------- ------- ---- -----------
PSGallery 2.0.0.0 ContosoServer Cmdlets and DSC resources for managing Contoso Server...
MySource 1.2.0.0 ContosoClient Cmdlets and DSC resources for managing Contoso Client...コマンドレットは Register-PSRepository 、新しいリポジトリを登録します。 Name パラメーターは MySource という名前を割り当てます。 SourceLocation パラメーターは、リポジトリのアドレスを指定します。
コマンドレットではFind-Module、Name パラメーターとアスタリスク (*) ワイルドカードを使用して Contoso モジュールを指定します。 Repository パラメーターは、PSGallery と MySource の 2 つのリポジトリを検索するように指定します。
例 7: DSC リソースを含むモジュールを検索する
このコマンドは、DSC リソースを含むモジュールを返します。 Includes パラメーターには、リポジトリの検索に使用される 4 つの定義済みの機能があります。 Tab-complete を使用して、 Includes パラメーターでサポートされている 4 つの機能を表示します。
Find-Module -Repository PSGallery -Includes DscResource
Version Name Repository Description
------- ---- ---------- -----------
2.7.0 Carbon PSGallery Carbon is a PowerShell module...
8.5.0.0 xPSDesiredStateConfiguration PSGallery The xPSDesiredStateConfiguration module...
1.3.1 PackageManagement PSGallery PackageManagement (a.k.a. OneGet) is...
2.7.0.0 xWindowsUpdate PSGallery Module with DSC Resources...
3.2.0.0 xCertificate PSGallery This module includes DSC resources...
3.1.0.0 xPowerShellExecutionPolicy PSGallery This DSC resource can change the user...コマンドレットでは Find-Module 、 Repository パラメーターを使用してリポジトリ PSGallery を検索します。
Includes パラメーターは DscResource を指定します。これは、パラメーターがリポジトリで検索できる機能です。
例 8: フィルターを使用してモジュールを検索する
この例では、モジュールを検索するために、フィルターを使用してリポジトリを検索します。
NuGet ベースのリポジトリの場合、 Filter パラメーターは引数の名前、説明、タグを検索します。
Find-Module -Filter AppDomain
Version Name Repository Description
------- ---- ---------- -----------
1.0.0.0 AppDomainConfig PSGallery Manipulate AppDomain configuration...
1.1.0 ClassExplorer PSGallery Quickly search the AppDomain for classes...コマンドレットは Find-ModuleFilter パラメーターを使用して、 AppDomain のリポジトリを検索します。
パラメーター
-AllowPrerelease
プレリリースとしてマークされた結果モジュールに含まれます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllVersions
モジュールのすべてのバージョンを結果に含むように指定します。 MinimumVersion、MaximumVersion、または RequiredVersion パラメーターで AllVersions パラメーターを使用することはできません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Command
モジュール内で検索するコマンドの配列を指定します。 コマンドには、関数またはワークフローを指定できます。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| 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 |
-DscResource
DSC リソースを含むモジュールの名前または名前の一部を指定します。 PowerShell 規則に従って、複数の引数を指定すると OR 検索が実行されます。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
PackageManagement プロバイダー固有の検索構文に基づいてフィルターを指定します。 NuGet モジュールの場合、このパラメーターは、PowerShell ギャラリー Web サイトのSearch バーを使用した検索と同じです。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeDependencies
この操作に、 Name パラメーターで指定されたモジュールに依存するすべてのモジュールが含まれていることを示します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Includes
特定の種類の PowerShell 機能を含むモジュールのみを返します。 たとえば、 DSCResource を含むモジュールのみを検索できます。 このパラメーターに使用できる値は次のとおりです。
- コマンドレット
- DscResource
- 機能
- RoleCapability
| Type: | String[] |
| Accepted values: | DscResource, Cmdlet, Function, RoleCapability |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumVersion
検索結果に含めるモジュールの最大バージョン (最新バージョン) を指定します。 MaximumVersion と RequiredVersion は、同じコマンドでは使用できません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MinimumVersion
結果に含めるモジュールの最小バージョンを指定します。 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: | False |
| Accept pipeline input: | True |
| 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
Repository パラメーターを使用して、モジュールを検索するリポジトリを指定します。 複数のリポジトリが登録されている場合に使用されます。 リポジトリのコンマ区切りのリストを受け入れます。 リポジトリを登録するには、 を使用 Register-PSRepositoryします。 登録済みリポジトリを表示するには、 を使用 Get-PSRepositoryします。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredVersion
結果に含めるモジュールの正確なバージョン番号を指定します。 RequiredVersion は、 MinimumVersion または MaximumVersion と同じコマンドでは使用できません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RoleCapability
ロール機能の配列を指定します。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
タグの配列を指定します。 タグの例としては、 DesiredStateConfiguration、 DSC、 DSCResourceKit、 PSModule などがあります。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
String[]
出力
PSRepositoryItemInfo
Find-Moduleは、 などのInstall-Moduleコマンドレットにパイプラインを送信できる PSRepositoryItemInfo オブジェクトを作成します。
メモ
重要
2020 年 4 月時点で、PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 および 1.1 がサポートされなくなります。 TLS 1.2 以降を使用していない場合、PowerShell ギャラリーにアクセスしようとするとエラーが発生します。 次のコマンドを使用して、確実に TLS 1.2 を使用するようにします。
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
詳細については、PowerShell ブログのお知らせを参照してください。