diff --git a/ThirdPartyNotices.md b/ThirdPartyNotices.md index 8daacc3..748b524 100644 --- a/ThirdPartyNotices.md +++ b/ThirdPartyNotices.md @@ -9,16 +9,16 @@ Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at -[https://go.microsoft.com/fwlink/?LinkID=254653][02]. +[Microsoft Trademark and Brand Guidelines][02]. -Privacy information can be found at [https://privacy.microsoft.com][04]. +Privacy information can be found at [Privacy at Microsoft][04]. Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise. [01]: https://creativecommons.org/licenses/by/4.0/legalcode -[02]: https://go.microsoft.com/fwlink/?LinkID=254653 +[02]: https://www.microsoft.com/legal/intellectualproperty/trademarks [03]: https://opensource.org/licenses/MIT [04]: https://privacy.microsoft.com [05]: LICENSE diff --git a/dsc/dsc-3.0/PSDesiredStateConfiguration/ConvertTo-DscJsonSchema.md b/dsc/dsc-3.0/PSDesiredStateConfiguration/ConvertTo-DscJsonSchema.md deleted file mode 100644 index 2e4767b..0000000 --- a/dsc/dsc-3.0/PSDesiredStateConfiguration/ConvertTo-DscJsonSchema.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: PSDesiredStateConfiguration-help.xml -Module Name: PSDesiredStateConfiguration -ms.date: 09/14/2021 -online version: https://learn.microsoft.com/powershell/module/psdesiredstateconfiguration/convertto-dscjsonschema?view=dsc-3.0&WT.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# ConvertTo-DscJsonSchema - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -ConvertTo-DscJsonSchema [[-Directory] ] [] -``` - -## DESCRIPTION -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -Directory -{{ Fill Directory Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, --InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see -[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md b/dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md index 65ef659..086d6c5 100644 --- a/dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md +++ b/dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md @@ -4,29 +4,42 @@ Help Version: 7.2.0.0 Locale: en-US Module Guid: 779e0998-8c72-4567-89b5-49313fc15351 Module Name: PSDesiredStateConfiguration -ms.date: 12/13/2021 +ms.date: 04/18/2025 schema: 2.0.0 title: PSDesiredStateConfiguration --- # PSDesiredStateConfiguration Module ## Description -This module contains cmdlets that designed to work with DSC Resources. PSDesiredStateConfiguration -v3.0 is the version of DSC that is supported by Azure Guest Configuration. -## PSDesiredStateConfiguration Cmdlets +The PSDesiredStateConfiguration module supports PowerShell Desired State Configuration (PSDSC). +Each major version of this module supports different use cases: + +- v1.1 is only supported for Windows PowerShell. You can use it to invoke PSDSC resources and to + author and apply PSDSC configurations. +- v2 is only supported for PowerShell. You can use it to invoke PSDSC resources and to compile + PSDSC configurations. It's intended use is to support Azure Machine Configuration. +- v3 (preview) is only supported for PowerShell. You can use it to invoke PSDSC resources. It's + intended use is for invoking PSDSC resources on Linux machines with Azure Machine Configuration. -### [Configuration](Configuration.md) -{{ Fill in the Description }} +Microsoft Desired State Configuration (DSC) enables you to manage PSDSC resources through two +adapters: -### ConvertTo-DscJsonSchema -{{ Fill in the Synopsis }} +- The `Microsoft.Windows/WindowsPowerShell` adapter enables you to invoke any PSDSC resource usable + with **PSDesiredStateConfiguration** version 1.1 in Windows PowerShell. +- The `Microsoft.DSC/PowerShell` adapter enables you to invoke any class-based PSDSC resource in + PowerShell. It doesn't rely on the **PSDesiredStateConfiguration** module. + +## PSDesiredStateConfiguration Cmdlets ### [Get-DscResource](Get-DscResource.md) + Gets the DSC resources present on the computer. ### [Invoke-DscResource](Invoke-DscResource.md) + Runs a method of a specified PowerShell Desired State Configuration (DSC) resource. ### [New-DSCCheckSum](New-DSCCheckSum.md) + Creates checksum files for DSC documents and DSC resources.