PowerShell Logo Small

Get-DscResource



This is the built-in help made by Microsoft for the command 'Get-DscResource', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Gets Desired State Configuration resources present on the computer.

SYNTAX


Get-DscResource [[-Name] <String[]>] [-Syntax] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-DscResource cmdlet retrieves the Desired State Configuration resources present on the computer. It shows built-in and custom providers (created by the user), as well
as composite resources (other configurations that are packaged as module or created at run time in the session).



<

RELATED LINKS


Online Version: http://go.microsoft.com/fwlink/?linkid=327746
Windows PowerShell Desired State Configuration Overview



REMARKS

<

Examples


Example 1: Get all resources on the local computer

PS C:\> Get-DscResource



This command gets all the resources on the local computer.




Example 2: Get a resource by specifying the name

PS C:\> Get-DscResource –Name WindowsFeature



This command gets the WindowsFeature resource.




Example 3: Get a resource by using wildcard characters

PS C:\> Get-DscResource –Name P*,r*



This command gets all resources that match the wildcard pattern specified by the Name parameter.




Example 4: Get a resource syntax

PS C:\> Get-DscResource -Name WindowsFeature -Syntax



This command gets the WindowsFeature resource, and shows the syntax for the resource.




Example 5: Get all the properties for a resource

PS C:\> Get-DscResource User | Select-Object -ExpandProperty Properties



This command gets the User resource, and then uses the pipeline operator to return all the properties for the User resource.