Find-Module

参考

模块:: PowerShellGet

在存储库中查找符合指定条件的模块。

语法

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>]

说明

cmdlet Find-Module 在存储库中查找与指定条件匹配的模块。 Find-Module 为其找到的每个模块返回 一个 PSRepositoryItemInfo 对象。对象可以在管道中向下发送到 cmdlet，例如 Install-Module。

首次尝试使用存储库时 Find-Module ，系统可能会提示你安装更新。如果未向 cmdlet 注册 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...

cmdlet 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

cmdlet 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...

cmdlet 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...

cmdlet 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...

cmdlet 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...

cmdlet Register-PSRepository 注册新的存储库。 Name 参数分配名称 MySource。 SourceLocation 参数指定存储库的地址。

cmdlet Find-Module 使用带有星号的 Name 参数 (*) 通配符来指定 Contoso 模块。 Repository 参数指定搜索两个存储库：PSGallery 和 MySource。

示例 7：查找包含 DSC 资源的模块

此命令返回包含 DSC 资源的模块。 Includes 参数具有四个用于搜索存储库的预定义功能。使用 Tab-complete 显示 Includes 参数支持的四个功能。

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...

cmdlet 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...

cmdlet Find-Module 使用 Filter 参数在存储库中搜索 AppDomain。

参数

-AllowPrerelease

在标记为预发布的结果模块中包含。

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

-AllVersions

指定在结果中包含模块的所有版本。不能将 AllVersions 参数与 MinimumVersion、MaximumVersion 或 RequiredVersion 参数一起使用。

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 库网站上的搜索栏进行搜索。

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 的模块。此参数的可接受值如下所示：

Cmdlet
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

为请求指定代理服务器，而不是直接连接到 Internet 资源。

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[]

String

Uri

PSCredential

输出

PSRepositoryItemInfo

Find-Module 创建 PSRepositoryItemInfo 对象，这些对象可在管道中向下发送到 cmdlet，例如 Install-Module。

备注

重要

自 2020 年 4 月起，PowerShell 库已不再支持传输层安全性 (TLS) 版本 1.0 和 1.1。如果你使用的不是 TLS 1.2 或更高版本，那么，在尝试访问 PowerShell 库时，将会收到错误。使用以下命令可以确定使用的是 TLS 1.2：

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

有关详细信息，请参阅 PowerShell 博客中的公告。

通过