Find-DscResource

Module:

PowerShellGet Module

Finds Desired State Configuration (DSC) resources.

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

The Find-DscResource cmdlet searches registered repositories to find DSC resources contained in modules. By default Find-DscResource searches all registered repositories.

For each module found by Find-DscResource, a PSGetDscResourceInfo object is returned. PSGetDscResourceInfo objects can be sent down the pipeline to the Install-Module cmdlet. Install-Module installs the module.

Find-DscResource returns DSC resources from registered repositories. To search a specific repository, use the Repository parameter.

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

Find-DscResource locates DSC resources by name. Use commas to separate an array of resource names.

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 uses the Name parameter to find the specified array of DSC resources.

Find-DscResource locates a DSC resource and sends the object down the pipeline to be installed. After the installation, use Get-InstalledModule to view the results.

Multiple resources from the same module can be sent down the pipeline to the Install-Module. Install-Module attempts to only install the module once.

Find-DscResource -Name xWebsite | Install-Module

Find-DscResource uses the Name parameter to find the resource named xWebsite. The object is sent down the pipeline to the Install-Module cmdlet. Install-Module installs the xWebAdministration module for the resource.

Find-DscResource finds all the DSC resources contained in a specified module. By default, the current version is displayed. To display other versions, use the AllVersions or RequiredVersions parameters.

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 uses the ModuleName parameter to specify the xWebAdministration and find the DSC resources contained in the module. The current version of each resource is displayed.

DSC resources can be located using the parameters Tag and RequiredVersion. Tag displays the current version of every resource that contains the specified tag in the repository. RequiredVersion needs the ModuleName parameter and the Name parameter is optional. The Name and ModuleName parameters limit the output. Use the AllVersions parameter to display a DSC resource's available versions.

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

Find-DscResource finds all resources and uses the Filter parameter to specify the results by Domain. The Filter parameter finds the filter value in the object's description or module name. Use the Select-Object cmdlet to view an object's properties.

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

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Find-DscResource returns a PSGetDscResourceInfo object.