bin/DSCParser.PSDSC.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>DSCParser.PSDSC</name> </assembly> <members> <member name="T:DSCParser.PSDSC.DscClassCacheReflection"> <summary> Typed wrappers around the internal PowerShell DscClassCache. The type and its methods are resolved once and cached, because several of these are called once per discovered resource. Every member tolerates the internal type being absent on the running PowerShell edition. </summary> </member> <member name="M:DSCParser.PSDSC.DscClassCacheReflection.ImportClassResourcesFromModule(System.Management.Automation.PSModuleInfo,System.Collections.Generic.ICollection{System.String})"> <summary> Registers the class-based resources of a module as DSC keywords. </summary> <param name="module">The module to import from.</param> <param name="resourcesToImport"> Names to register. A module whose file also declares the complex types its resources use - which every class-based resource of any size does - would otherwise get a keyword per complex type as well, because "*" matches every class in the parsed file. </param> </member> <member name="T:DSCParser.PSDSC.DscKeywordRegistry"> <summary> Registers a module's DSC resources as dynamic keywords and remembers which modules have already been registered. </summary> <remarks> PowerShell rebuilds this registration from scratch every time it parses a configuration that contains an Import-DSCResource statement, probing the file system for a schema file per resource. On a module the size of Microsoft365DSC that dominates the cost of parsing. Keeping the registration for the lifetime of the process lets callers strip the Import-DSCResource statement and skip that work entirely. </remarks> </member> <member name="M:DSCParser.PSDSC.DscKeywordRegistry.ImportModules(System.Collections.Generic.IEnumerable{System.Management.Automation.PSModuleInfo})"> <summary> Registers the resources of the supplied modules, skipping modules already registered. </summary> </member> <member name="M:DSCParser.PSDSC.DscKeywordRegistry.EnsureRegistered(System.String,System.Version)"> <summary> Ensures the resources of a module are registered as dynamic keywords. </summary> <param name="moduleName">The module to register.</param> <param name="version">The required version, or null for every installed version.</param> <returns>False when no matching module is installed.</returns> </member> <member name="M:DSCParser.PSDSC.DscKeywordRegistry.Reset"> <summary> Drops every registered keyword and the underlying class cache. </summary> </member> <member name="T:DSCParser.PSDSC.DscResourceHelpers"> <summary> Helper methods for DSC resource operations </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.IsHiddenResource(System.String)"> <summary> Checks whether a resource is hidden and should not be shown to users </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.IsPatternMatched(System.String[],System.String)"> <summary> Checks whether an input name matches one of the patterns. Patterns use PowerShell wildcard syntax, matching the -Name parameter contract of Get-DscResourceV2. </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.GetImplementingModulePath(System.String)"> <summary> Gets implementing module path from schema file path </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.ClearModuleCache"> <summary> Drops the per-discovery-run module resolution cache. Must be called when discovery ends so a later run does not observe stale module or file-system state. </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.GetModule(System.Management.Automation.PSModuleInfo[],System.String)"> <summary> Gets module for a DSC resource from schema file </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.ValidateResourceModule(System.String,System.String)"> <summary> Validates that a schema file corresponds to a proper DSC resource module </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.GetDscResourceModules"> <summary> Gets DSC resource modules from PSModulePath </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.ConvertTypeConstraintToTypeName(System.String)"> <summary> Converts MOF type constraint to PowerShell type name </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceHelpers.GetSyntax(Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo)"> <summary> Generates syntax string for a DSC resource </summary> </member> <member name="T:DSCParser.PSDSC.DscResourceService"> <summary> Static entry point for DSC resource discovery that can be called from C# code. Provides programmatic access to DSC resources without requiring PowerShell cmdlet invocation. </summary> </member> <member name="P:DSCParser.PSDSC.DscResourceService.WarningSink"> <summary> Receives non-fatal diagnostics. Hosts such as the Get-DscResourceV2 cmdlet wire this to their warning stream. When unset, diagnostics are dropped rather than written to the console. </summary> </member> <member name="M:DSCParser.PSDSC.DscResourceService.GetDscResources(System.String[],System.String,System.Boolean)"> <summary> Gets DSC resources on the machine with optional filtering. </summary> <param name="resourceNames">Optional array of resource names to filter on (supports wildcards)</param> <param name="moduleName">Optional module name to filter on</param> <param name="includeCompositeResources">Whether to include composite (configuration-based) resources</param> <returns>List of discovered DSC resources</returns> </member> <member name="M:DSCParser.PSDSC.DscResourceService.GetResourceSyntax(Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo)"> <summary> Gets the syntax string for a DSC resource. </summary> <param name="resource">The DSC resource to get syntax for</param> <returns>Formatted syntax string</returns> </member> <member name="T:DSCParser.PSDSC.GetDscResourceCommand"> <summary> Gets DSC resources on the machine. Allows filtering on a particular resource. High-performance compiled version of Get-DscResource cmdlet. </summary> </member> <member name="P:DSCParser.PSDSC.GetDscResourceCommand.Name"> <summary> Gets or sets the resource name(s) to filter on </summary> </member> <member name="P:DSCParser.PSDSC.GetDscResourceCommand.Module"> <summary> Gets or sets the module to filter on </summary> </member> <member name="P:DSCParser.PSDSC.GetDscResourceCommand.Syntax"> <summary> Gets or sets whether to return syntax instead of resource objects </summary> </member> <member name="M:DSCParser.PSDSC.GetDscResourceCommand.BeginProcessing"> <summary> BeginProcessing - Parse module parameter </summary> </member> <member name="M:DSCParser.PSDSC.GetDscResourceCommand.ProcessRecord"> <summary> ProcessRecord - Discover and output DSC resources using the static service </summary> </member> <member name="M:DSCParser.PSDSC.GetDscResourceCommand.CheckResourcesFound(System.String[],System.Collections.Generic.List{Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo})"> <summary> Checks that all requested resources were found </summary> </member> <member name="T:DSCParser.PSDSC.ResourceProcessor"> <summary> Resource processor for CIM/MOF-based DSC resources </summary> </member> <member name="M:DSCParser.PSDSC.ResourceProcessor.GetResourceFromKeyword(System.Management.Automation.Language.DynamicKeyword,System.String[],System.Management.Automation.PSModuleInfo[])"> <summary> Gets resource from a dynamic keyword (CIM-based resource) </summary> </member> <member name="M:DSCParser.PSDSC.ResourceProcessor.GetCompositeResource(System.String[],System.Management.Automation.ConfigurationInfo,System.Collections.Generic.HashSet{System.String},System.Management.Automation.PSModuleInfo[])"> <summary> Gets composite resource from configuration info </summary> </member> <member name="M:DSCParser.PSDSC.ResourceProcessor.AddPropertiesFromKeyword(Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo,System.Management.Automation.Language.DynamicKeyword)"> <summary> Adds properties to resource from dynamic keyword </summary> </member> <member name="M:DSCParser.PSDSC.ResourceProcessor.AddPropertiesFromMetadata(Microsoft.PowerShell.DesiredStateConfiguration.DscResourceInfo,System.Collections.Generic.IEnumerable{System.Management.Automation.ParameterMetadata},System.Collections.Generic.HashSet{System.String})"> <summary> Adds properties to resource from parameter metadata (composite resources) </summary> </member> </members> </doc> |