Skip to content

Update PSDesiredStateConfiguration.md to improve clarity #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2025
Merged

Update PSDesiredStateConfiguration.md to improve clarity #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 0 additions & 65 deletions dsc/dsc-3.0/PSDesiredStateConfiguration/ConvertTo-DscJsonSchema.md
View file
Open in desktop

This file was deleted.

29 changes: 21 additions & 8 deletions dsc/dsc-3.0/PSDesiredStateConfiguration/PSDesiredStateConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.