| external help file | GeneratedBy | Module Name | online version | schema |
|---|---|---|---|---|
PSDSC-help.xml |
Sampler update_help_source task |
PSDSC |
2.0.0 |
Retrieves the schema for a specified DSC resource.
Get-PsDscResourceSchema [-ResourceName] <String> [-IncludeProperty] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
The function Get-PsDscResourceSchema function retrieves the schema for a specified Desired State Configuration (DSC) resource. It can optionally include the properties of the resource in the output.
Get-PsDscResourceSchema -ResourceName "Microsoft.Windows/Registry"
Retrieves the schema for the "Microsoft.Windows/Registry" DSC resource.
Get-PsDscResourceSchema -ResourceName "Microsoft.WinGet.DSC/WinGetPackage" -IncludeProperty
Retrieves the schema for the "Microsoft.WinGet.DSC/WinGetPackage" DSC resource and includes its properties in the output onyl.
The name of the DSC resource for which to retrieve the schema.
Type: String
Parameter Sets: (All)
Aliases: Name
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA switch parameter that, when specified, includes the properties of the DSC resource in the output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
For more details, refer to the module documentation.