Skip to content

Latest commit

 

History

History
124 lines (88 loc) · 2.51 KB

Get-PsDscResource.md

File metadata and controls

124 lines (88 loc) · 2.51 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
Get-PsDscResource

Get-PsDscResource

SYNOPSIS

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

SYNTAX

__AllParameterSets

Get-PsDscResource [-Resource] <string> [-Inputs] <Object> [<CommonParameters>]

ALIASES

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

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

Get-PsDscResource -Resource 'Microsoft.Windows/Registry' -Inputs @{ keyPath = 'HKCU\1\2' }

This example retrieves the 'Microsoft.Windows/Registry' DSC resource with the specified inputs.

EXAMPLE 2

$params = @{ Resource = 'Microsoft.Windows/Registry' Inputs = 'registry.json' } PS C:> Get-PsDscResource @params

This example retrieves the 'Microsoft.Windows/Registry' DSC resource with the inputs provided in the 'registry.json' file.

PARAMETERS

-Inputs

The input to provide. Supports a hashtable of key-value pairs, JSON, YAML, or a file path (both JSON and YAML).

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

-Resource

The resource (name) to be retrieved.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases:
- ResourceName
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  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 }}