Find-Module

モジュール:

PowerShellGet Module

指定された条件に一致するリポジトリ内のモジュールを検索します。

構文

All

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 は、ソース間で名前の競合が発生する可能性があるため、使用可能なすべてのモジュールを検索します。

モジュールのバージョン番号を受け取るパラメーターには、バージョン番号として書式設定された文字列が必要です。

• 標準バージョン番号には、x、y、z が数値である x.y.z の形式があります
• プレリリース バージョンには、x.y.z-<prerelease_label>がそのリリースに割り当てられた任意の文字列である<prerelease_label>の形式があります。

次の例では、登録されている唯一のリポジトリとして 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: 特定のバージョンでモジュールを検索する

この例では、モジュールの特定のプレリリース バージョンをインストールする方法を示します。 プレリリース バージョンには、 <version_number>-<prerelease_label>の形式があります。

Find-Module PSReadLine -AllowPrerelease -RequiredVersion 2.2.4-beta1

Version        Name             Repository       Description
-------        ----             ----------       -----------
2.2.4-beta1    PSReadLine       PSGallery        Great command line editing in the PowerS…

例 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 つの定義済みの機能があります。 タブコンプリートを使用して、 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-Module コマンドレットでは、Filter パラメーターを使用して、AppDomain のリポジトリを検索します。

例 9: タグでモジュールを検索する

この例では、タグによってモジュールを検索する方法を示します。 CrescendoBuilt値は、Microsoft.PowerShell.Crescendo モジュールを使用して作成されたモジュールに自動的に追加されるタグです。

Find-Module -Tag CrescendoBuilt

Version Name            Repository Description
------- ----            ---------- -----------
0.1.0   Foil            PSGallery  A PowerShell Crescendo wrapper for Chocolatey
0.3.1   Cobalt          PSGallery  A PowerShell Crescendo wrapper for WinGet
1.1.0   SysInternals    PSGallery  PowerShell cmdlets for SysInternal tools
0.0.4   Croze           PSGallery  A PowerShell Crescendo wrapper for Homebrew
0.0.2   AptPackage      PSGallery  PowerShell Crescendo-generated Module to query APT-Package Information
1.0.1   RoboCopy        PSGallery  PowerShell cmdlet for the official RoboCopy.exe
1.0.2   TShark          PSGallery  PowerShell cmdlet for tshark.exe
1.0.0   SpeedTestCLI    PSGallery  PowerShell cmdlets speedtest-cli
1.0.0   SpeedTest-CLI   PSGallery  PowerShell cmdlets for Internet Speed Test
1.0.2   Image2Text      PSGallery  PowerShell Images into ASCII art
0.1.1   Quser.Crescendo PSGallery  This module displays session information of users logged onto a local or remote m...
1.0.2   Takeown         PSGallery  Crescendo Powershell wrapper of takeown.exe

パラメーター

-AllowPrerelease

プレリリースとしてマークされた結果モジュールに含まれます。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-AllVersions

結果にモジュールのすべてのバージョンを含むように指定します。 MinimumVersion、MaximumVersion、または RequiredVersion パラメーターで AllVersions パラメーターを使用することはできません。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Command

モジュールで検索するコマンドの配列を指定します。 コマンドには、関数またはワークフローを指定できます。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Credential

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

パラメーターのプロパティ

型:	PSCredential
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-DscResource

DSC リソースを含むモジュールの名前または名前の一部を指定します。 PowerShell の規則に従って、複数の引数を指定すると OR 検索が実行されます。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Filter

PackageManagement プロバイダー固有の検索構文に基づいてフィルターを指定します。 NuGet モジュールの場合、このパラメーターは PowerShell ギャラリー Web サイトの検索バーを使用した検索と同じです。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-IncludeDependencies

この操作に 、Name パラメーターで指定されたモジュールに依存するすべてのモジュールが含まれていることを示します。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Includes

特定の種類の PowerShell 機能を含むモジュールのみを返します。 たとえば、 DSCResource を含むモジュールのみを検索できます。 このパラメーターに使用できる値は次のとおりです。

• コマンドレット
• DscResource
• 機能
• ロール機能

パラメーターのプロパティ

型:	String[]
規定値:	None
指定可能な値:	DscResource, Cmdlet, Function, RoleCapability
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-MaximumVersion

検索結果に含めるモジュールの最大バージョン (最新バージョン) を指定します。 MaximumVersion と RequiredVersion を同じコマンドで使用することはできません。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-MinimumVersion

結果に含めるモジュールの最小バージョンを指定します。 MinimumVersion と RequiredVersion を同じコマンドで使用することはできません。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Name

リポジトリ内で検索するモジュールの名前を指定します。 モジュール名のコンマ区切りのリストを使用できます。 ワイルドカードを使用できます。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	True
DontShow:	False

パラメーター セット

(All)

配置:	0
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Proxy

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

パラメーターのプロパティ

型:	Uri
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-ProxyCredential

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

パラメーターのプロパティ

型:	PSCredential
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Repository

Repository パラメーターを使用して、モジュールを検索するリポジトリを指定します。 複数のリポジトリが登録されている場合に使用されます。 リポジトリのコンマ区切りのリストを受け入れます。 リポジトリを登録するには、 Register-PSRepositoryを使用します。 登録済みリポジトリを表示するには、 Get-PSRepositoryを使用します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-RequiredVersion

結果に含めるモジュールの正確なバージョン番号を指定します。 MinimumVersion または MaximumVersion と同じコマンドでは、RequiredVersion を使用できません。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-RoleCapability

ロール機能の配列を指定します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Tag

タグの配列を指定します。 タグの例としては、 DesiredStateConfiguration、 DSC、 DSCResourceKit、 PSModule などがあります。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

String

String

Uri

PSCredential

出力

PSRepositoryItemInfo

Find-Moduleは、パイプラインをなどのコマンドレットに送信できる Install-Module オブジェクトを作成します。

メモ

PowerShell には、Find-Moduleの次のエイリアスが含まれています。

• すべてのプラットフォーム:
  • fimo

Von Bedeutung

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

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

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

関連リンク

• Get-PSRepository
• Install-Module
• Publish-Module
• Save-Module
• Uninstall-Module
• Update-Module
• Register-PSRepository