Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 2.9 KB

Find-PsDscResource.md

File metadata and controls

148 lines (108 loc) · 2.9 KB
document type external help file HelpUri Locale Module Name ms.date PlatyPS schema version title
cmdlet
PSDSC-Help.xml
en-US
PSDSC
02/28/2025
2024-05-01
Find-PsDscResource

Find-PsDscResource

SYNOPSIS

Invoke the list operation for DSC version 3 command-line utility.

SYNTAX

__AllParameterSets

Find-PsDscResource [[-AdapterName] <string>] [[-Description] <string>] [[-Tag] <string>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

The function Find-PsDscResource invokes the list operation on Desired State Configuration version 3 executable 'dsc.exe'.

EXAMPLES

EXAMPLE 1

Find-PsDscResource -Adapter 'Microsoft.Windows/WindowsPowerShell' -Description 'This is a test description' -Tag 'Test'

This example finds the DSC resources with the specified adapter, description, and tag.

EXAMPLE 2

Find-PsDscResource

This example finds the DSC resources without any filters. It does not get any adapted resources.

PARAMETERS

-AdapterName

The adapter name to filter on. Supported values are 'Microsoft.DSC/PowerShell', 'Microsoft.Windows/WMI', and 'Microsoft.Windows/WindowsPowerShell'.

The adapter name is optional.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- Adapter
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Description

The description to filter on. The description is optional.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Tag

The tag to filter on. The tag is optional.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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.

INPUTS

OUTPUTS

System.Management.Automation.PSObject

{{ Fill in the Description }}

NOTES

For more details, go to module repository at: https://github.com/Gijsreyn/PSDSC.

RELATED LINKS

{{ Fill in the related links here }}