Find-DscResource

  • リファレンス
モジュール:
PowerShellGet

Desired State Configuration (DSC) リソースを検索します。

構文

Find-DscResource
    [[-Name] <String[]>]
    [-ModuleName <String>]
    [-MinimumVersion <String>]
    [-MaximumVersion <String>]
    [-RequiredVersion <String>]
    [-AllVersions]
    [-AllowPrerelease]
    [-Tag <String[]>]
    [-Filter <String>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Repository <String[]>]
    [<CommonParameters>]

説明

コマンドレットは Find-DscResource 、登録済みのリポジトリを検索して、モジュールに含まれる DSC リソースを検索します。 既定では Find-DscResource 、登録されているすべてのリポジトリが検索されます。

によって検出された Find-DscResourceモジュールごとに、 PSGetDscResourceInfo オブジェクトが返されます。 PSGetDscResourceInfo オブジェクトは、パイプラインをコマンドレットに Install-Module 送信できます。 Install-Module モジュールをインストールします。

例

例 1: すべての DSC リソースを検索する

Find-DscResource は、登録済みリポジトリから DSC リソースを返します。 特定のリポジトリを検索するには、 Repository パラメーターを使用します。

Find-DscResource

Name                           Version    ModuleName                     Repository
----                           -------    ----------                     ----------
Carbon_Privilege               2.8.1      Carbon                         PSGallery
Carbon_ScheduledTask           2.8.1      Carbon                         PSGallery
Carbon_Service                 2.8.1      Carbon                         PSGallery
PackageManagement              1.4        PackageManagement              PSGallery
PackageManagementSource        1.4        PackageManagement              PSGallery
PSModule                       2.1.4      PowerShellGet                  PSGallery
PSRepository                   2.1.4      PowerShellGet                  PSGallery
xArchive                       8.7.0.0    xPSDesiredStateConfiguration   PSGallery
xDSCWebService                 8.7.0.0    xPSDesiredStateConfiguration   PSGallery
xEnvironment                   8.7.0.0    xPSDesiredStateConfiguration   PSGallery

例 2: 名前で DSC リソースを検索する

Find-DscResource DSC リソースを名前で検索します。 リソース名の配列を区切るには、コンマを使用します。

Find-DscResource -Name xWebsite, xWebApplication, xWebSiteDefaults

Name               Version    ModuleName            Repository
----               -------    ----------            ----------
xWebApplication    2.6.0.0    xWebAdministration    PSGallery
xWebsite           2.6.0.0    xWebAdministration    PSGallery
xWebSiteDefaults   2.6.0.0    xWebAdministration    PSGallery

Find-DscResourceは Name パラメーターを使用して、DSC リソースの指定された配列を検索します。

例 3: DSC リソースを見つけてインストールする

Find-DscResource は DSC リソースを検索し、インストールするパイプラインの下にオブジェクトを送信します。 インストール後、 を使用 Get-InstalledModule して結果を表示します。

同じモジュールの複数のリソースをパイプラインから に Install-Module送信できます。 Install-Module では、モジュールのインストールが 1 回だけ試行されます。

Find-DscResource -Name xWebsite | Install-Module

Find-DscResourceは Name パラメーターを使用して、xWebsite という名前のリソースを検索します。 オブジェクトは、パイプラインの下にコマンドレットに Install-Module 送信されます。 Install-Module は、リソースの xWebAdministration モジュールをインストールします。

例 4: モジュール内のすべての DSC リソースを検索する

Find-DscResource は、指定したモジュールに含まれるすべての DSC リソースを検索します。 既定では、現在のバージョンが表示されます。 他のバージョンを表示するには、 AllVersions または RequiredVersions パラメーター を 使用します。

Find-DscResource -ModuleName xWebAdministration

Name                                Version    ModuleName              Repository
----                                -------    ----------              ----------
WebApplicationHandler               2.6.0.0    xWebAdministration      PSGallery
xIisFeatureDelegation               2.6.0.0    xWebAdministration      PSGallery
xIisHandler                         2.6.0.0    xWebAdministration      PSGallery
xIisLogging                         2.6.0.0    xWebAdministration      PSGallery

Find-DscResourceでは ModuleName パラメーターを使用して xWebAdministration を指定し、モジュールに含まれる DSC リソースを検索します。 各リソースの現在のバージョンが表示されます。

例 5: タグと必要なバージョンで DSC リソースを検索する

DSC リソースは、 Tag パラメーターと RequiredVersion パラメーターを使用して配置できます。 [タグ] には、リポジトリ内の指定したタグを含むすべてのリソースの現在のバージョンが表示されます。 RequiredVersion には ModuleName パラメーターが必要で、 Name パラメーターは省略可能です。 Name パラメーターと ModuleName パラメーターは、出力を制限します。 AllVersions パラメーターを使用して、DSC リソースの使用可能なバージョンを表示します。

Find-DscResource -ModuleName xWebAdministration -Tag DSC -RequiredVersion 1.20

Name                    Version    ModuleName             Repository
----                    -------    ----------             ----------
xIisFeatureDelegation   1.20.0.0   xWebAdministration     PSGallery
xIisHandler             1.20.0.0   xWebAdministration     PSGallery
xIisLogging             1.20.0.0   xWebAdministration     PSGallery
xIisMimeTypeMapping     1.20.0.0   xWebAdministration     PSGallery

例 6: フィルターを使用してリソースを検索する

Find-DscResource は、すべてのリソースを検索し、 Filter パラメーターを使用して Domain で結果を指定 します。 Filter パラメーターは、オブジェクトの説明またはモジュール名でフィルター値を検索します。 コマンドレットを Select-Object 使用して、オブジェクトのプロパティを表示します。

Find-DscResource -Filter Domain

Name                    Version    ModuleName                 Repository
----                    -------    ----------                 ---------
xComputer               4.1.0.0    xComputerManagement        PSGallery
Computer                6.4.0.0    ComputerManagementDsc      PSGallery
xDSCDomainjoin          1.1        xDSCDomainjoin             PSGallery
xDisk                   1.0        xDisk                      PSGallery
xDSCFirewall            1.6.21     xDSCFirewall               PSGallery
dmAwsTagInstance        1.0.1      domainAwsDSCResources      PSGallery

パラメーター

-AllowPrerelease

結果にプレリリースとしてマークされたリソースが含まれます。

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

-AllVersions

AllVersions パラメーターには、DSC リソースの使用可能な各バージョンが表示されます。 MinimumVersion、MaximumVersion、または RequiredVersion パラメーターで AllVersions パラメーターを使用することはできません。

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

-Filter

PackageManagement プロバイダーの検索構文に基づいてリソースを検索します。 たとえば、 ModuleName プロパティと Description プロパティ内で検索する単語を指定します。

Type:String
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:False
Accept wildcard characters:False

-MinimumVersion

結果に含めるリソースの最小バージョンを指定します。 MinimumVersion パラメーターと RequiredVersion パラメーターは、同じコマンドでは使用できません。

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

-ModuleName

DSC リソースを含むモジュールを指定します。

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

-Name

リソースの名前を指定します。 既定値は、すべてのリソースです。 リソース名の配列を区切るには、コンマを使用します。

Type:String[]
Position:0
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

リソースを検索するリポジトリを指定します。 リポジトリ名の配列を区切るには、コンマを使用します。

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

-RequiredVersion

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

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

-Tag

リポジトリ内のモジュールを分類するタグを指定します。 タグの配列を区切るには、コンマを使用します。

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

出力

PSGetDscResourceInfo

Find-DscResource は PSGetDscResourceInfo オブジェクトを 返します。

メモ

重要

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

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

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