Skip to content

Commit f19f5a4

Browse files
GijsreynG.Reijn
andauthored
Update PSDesiredStateConfiguration.md to improve clarity on module description for Microsoft DSC (#314)
Co-authored-by: G.Reijn <G.Reijn@enzazaden.nl>
1 parent 5b5d000 commit f19f5a4

File tree

2 files changed

+21
-73
lines changed

2 files changed

+21
-73
lines changed

dsc/dsc-3.0/PSDesiredStateConfiguration/ConvertTo-DscJsonSchema.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,42 @@ Help Version: 7.2.0.0
44
Locale: en-US
55
Module Guid: 779e0998-8c72-4567-89b5-49313fc15351
66
Module Name: PSDesiredStateConfiguration
7-
ms.date: 12/13/2021
7+
ms.date: 04/18/2025
88
schema: 2.0.0
99
title: PSDesiredStateConfiguration
1010
---
1111
# PSDesiredStateConfiguration Module
1212

1313
## Description
14-
This module contains cmdlets that designed to work with DSC Resources. PSDesiredStateConfiguration
15-
v3.0 is the version of DSC that is supported by Azure Guest Configuration.
1614

17-
## PSDesiredStateConfiguration Cmdlets
15+
The PSDesiredStateConfiguration module supports PowerShell Desired State Configuration (PSDSC).
16+
Each major version of this module supports different use cases:
17+
18+
- v1.1 is only supported for Windows PowerShell. You can use it to invoke PSDSC resources and to
19+
author and apply PSDSC configurations.
20+
- v2 is only supported for PowerShell. You can use it to invoke PSDSC resources and to compile
21+
PSDSC configurations. It's intended use is to support Azure Machine Configuration.
22+
- v3 (preview) is only supported for PowerShell. You can use it to invoke PSDSC resources. It's
23+
intended use is for invoking PSDSC resources on Linux machines with Azure Machine Configuration.
1824

19-
### [Configuration](Configuration.md)
20-
{{ Fill in the Description }}
25+
Microsoft Desired State Configuration (DSC) enables you to manage PSDSC resources through two
26+
adapters:
2127

22-
### ConvertTo-DscJsonSchema
23-
{{ Fill in the Synopsis }}
28+
- The `Microsoft.Windows/WindowsPowerShell` adapter enables you to invoke any PSDSC resource usable
29+
with **PSDesiredStateConfiguration** version 1.1 in Windows PowerShell.
30+
- The `Microsoft.DSC/PowerShell` adapter enables you to invoke any class-based PSDSC resource in
31+
PowerShell. It doesn't rely on the **PSDesiredStateConfiguration** module.
32+
33+
## PSDesiredStateConfiguration Cmdlets
2434

2535
### [Get-DscResource](Get-DscResource.md)
36+
2637
Gets the DSC resources present on the computer.
2738

2839
### [Invoke-DscResource](Invoke-DscResource.md)
40+
2941
Runs a method of a specified PowerShell Desired State Configuration (DSC) resource.
3042

3143
### [New-DSCCheckSum](New-DSCCheckSum.md)
44+
3245
Creates checksum files for DSC documents and DSC resources.

0 commit comments

Comments
 (0)