Find-DscResource
Desired State Configuration (DSC) リソースを検索します。
構文
All
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 モジュールをインストールします。
例
例 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
Install-Module コマンドレットに送信されます。
Install-Module は、リソースの xWebAdministration モジュールをインストールします。
例 4: モジュール内のすべての DSC リソースを検索する
Find-DscResource は、指定したモジュールに含まれるすべての DSC リソースを検索します。 既定では、現在のバージョンが表示されます。 他のバージョンを表示するには、
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 リソースは、タグ
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
結果にプレリリースとしてマークされたリソースが含まれます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AllVersions
AllVersions パラメーターには、DSC リソースの使用可能な各バージョンが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Filter
PackageManagement プロバイダーの検索構文に基づいてリソースを検索します。 たとえば、ModuleName 内で検索する単語と Description プロパティを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MaximumVersion
結果に含めるリソースの最大バージョンを指定します。 MaximumVersion パラメーターと RequiredVersion パラメーターを同じコマンドで使用することはできません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MinimumVersion
結果に含めるリソースの最小バージョンを指定します。 MinimumVersion と RequiredVersion パラメーターは、同じコマンドでは使用できません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModuleName
DSC リソースを含むモジュールを指定します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
リソースの名前を指定します。 既定値は、すべてのリソースです。 リソース名の配列を区切るには、コンマを使用します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | 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
リソースを検索するリポジトリを指定します。 リポジトリ名の配列を区切るには、コンマを使用します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RequiredVersion
結果に含めるモジュールの正確なバージョン番号を指定します。 RequiredVersion パラメーターと MinimumVersion パラメーターは、同じコマンドでは使用できません。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Tag
リポジトリ内のモジュールを分類するタグを指定します。 タグの配列を区切るには、コンマを使用します。
パラメーターのプロパティ
| 型: | 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を参照してください。
出力
PSGetDscResourceInfo
Find-DscResource は、PSGetDscResourceInfo オブジェクトを返します。
メモ
Von Bedeutung
2020 年 4 月の時点で、PowerShell ギャラリーはトランスポート層セキュリティ (TLS) バージョン 1.0 と 1.1 をサポートしなくなりました。 TLS 1.2 以降を使用していない場合は、PowerShell ギャラリーにアクセスしようとするとエラーが表示されます。 TLS 1.2 を使用していることを確認するには、次のコマンドを使用します。
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
詳細については、PowerShell ブログの のお知らせ を参照してください。