Skip to content

Commit e6be969

Browse files
committed
Update format
1 parent e3b83c9 commit e6be969

File tree

3 files changed

+179
-42
lines changed

3 files changed

+179
-42
lines changed

docs/troubleshooting/known-issues.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: 'Known issues: Microsoft Desired State Configuration'
3+
description: "Troubleshooting and known issues for Microsoft Desired State Configuration (DSC)."
4+
author: michaeltlombardi
5+
ms.author: mlombardi
6+
ms.service: dsc
7+
ms.topic: troubleshooting-known-issue
8+
ms.date: 07/14/2025
9+
---
10+
11+
# Known issues: Microsoft Desired State Configuration
12+
13+
This article lists known issues and troubleshooting guidance for Microsoft Desired State Configuration (DSC).
14+
15+
The following table lists known issues with Microsoft DSC v3:
16+
17+
| Issue | Description | Status | Reported on |
18+
| :-------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------ | :-------- | :--------------------------------------------------- |
19+
| [Unable to parse content from `<manifestUrl>`](#unable-to-parse-content-from-manifesturl) | When authoring a resource manifest in VSCode, you may encounter parsing errors. | Confirmed | [#917](https://github.com/PowerShell/DSC/issues/917) |
20+
| [Resource not found when using Windows PowerShell adapter](#resource-not-found-when-using-windows-powershell-adapter) | A resource cannot be found when running DSC configuration using WinPS adapter. | Confirmed | [#765](https://github.com/PowerShell/DSC/issues/765) |
21+
22+
For the most up-to-date information on known issues, visit the [DSC GitHub repository issues page](https://github.com/PowerShell/DSC/issues).
23+
24+
## Unable to parse content from `<manifestUrl>`
25+
26+
When authoring a resource manifest in Visual Studio Code (VSCode), you may encounter a parsing error:
27+
28+
> Unable to parse content from `<manifestUrl>`
29+
30+
This error occurs because canonical schema bundling is not fully supported in the 2020-12 JSON
31+
schema specification. It applies to Microsoft DSC v3.0 and above.
32+
33+
### Prerequisites
34+
35+
- Visual Studio Code
36+
- Microsoft DSC v3.0 or later
37+
38+
### Troubleshooting steps
39+
40+
To resolve this issue, use `manifest.vscode.json` in the schema URI for your resource manifest.
41+
This enables enhanced authoring support in VSCode.
42+
43+
For more information, see [Enhanced authoring][00].
44+
45+
### Possible causes
46+
47+
- The resource manifest references a schema that is not compatible with the VSCode JSON schema parser.
48+
- The canonical schema bundling feature is not yet supported in the 2020-12 JSON schema version
49+
used by VSCode.
50+
51+
## Resource not found when using Windows PowerShell adapter
52+
53+
When running DSC configurations with the Windows PowerShell (WinPS) adapter,
54+
you may encounter errors indicating that a required resource cannot be found.
55+
56+
### Prerequisites
57+
58+
- Windows PowerShell DSC (PSDSC) 1.1 (included with Windows)
59+
- DSC configuration using the WinPS adapter
60+
61+
### Issue description
62+
63+
The WinPS adapter relies on PSDSC 1.1, which uses the Local Configuration Manager (LCM) running
64+
as a Windows service. By design, the LCM service only accesses resources installed for "AllUsers"
65+
under the Program Files directory. If a DSC resource is installed for the current user only,
66+
the service cannot detect or use it, resulting in a "resource not found" error.
67+
68+
This limitation is specific to PSDSC 1.1. PSDSC v2 addresses this issue, but it is not
69+
included with Windows and requires separate installation.
70+
71+
### Troubleshooting steps
72+
73+
- Ensure all DSC resources required by your configuration are installed for "AllUsers" scope.
74+
- Reinstall any missing resources using an elevated prompt to guarantee system-wide availability.
75+
76+
### Possible causes
77+
78+
- DSC resources installed only for the current user, not for all users.
79+
- Using PSDSC 1.1, which restricts resource visibility to the "AllUsers" scope.
80+
81+
### Recommendation
82+
83+
Install all DSC resources, whether script-based and binary resources, for all users
84+
("AllUsers" scope) to ensure they are available for the WinPS adapter.
85+
86+
## See also
87+
88+
- [Microsoft Desired State Configuration overview](../overview.md)
89+
90+
<!-- Link references -->
91+
[00]: https://learn.microsoft.com/en-us/powershell/dsc/concepts/enhanced-authoring?view=dsc-3.0

docs/troubleshooting/troubleshooting.md

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

template.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: 'Known issues: Microsoft Desired State Configuration'
3+
description: "[Article description]."
4+
author: [your GitHub alias]
5+
ms.author: [your Microsoft alias or a team alias]
6+
ms.service: [the approved service name]
7+
ms.topic: troubleshooting-known-issue #Don't change.
8+
ms.date: [mm/dd/yyyy]
9+
10+
#customer intent: As a <role>, I want <what> so that <why>.
11+
12+
---
13+
14+
<!-- --------------------------------------
15+
16+
- Use this template with pattern instructions for:
17+
18+
Known Issues
19+
20+
- Before you sign off or merge:
21+
22+
Remove all comments except the customer intent.
23+
24+
-->
25+
26+
# Known issues: Microsoft Desired State Configuration
27+
28+
<!-- Required: Article headline - H1
29+
30+
Identify the product or service the article
31+
applies to.
32+
33+
-->
34+
35+
[Introduce and explain the purpose of the article.]
36+
37+
<!-- Required: Introductory paragraphs (no heading)
38+
39+
Write a brief introduction that can help the user
40+
determine whether the article is relevant for them
41+
and to describe the specific issue that the article
42+
covers.
43+
44+
-->
45+
46+
## [Issue]
47+
48+
<!-- Required: Issue - H2
49+
50+
Each known issue should be in its own section.
51+
Provide a title for the section so that users can
52+
easily identify the issue that they are experiencing.
53+
54+
-->
55+
56+
[Describe the issue.]
57+
58+
<!-- Required: Issue description (no heading)
59+
60+
Describe the issue.
61+
62+
-->
63+
64+
### Prerequisites
65+
66+
<!--Optional: Prerequisites - H3
67+
68+
Use clear and unambiguous language, and use
69+
an unordered list format.
70+
71+
-->
72+
73+
### Troubleshooting steps
74+
75+
<!-- Optional: Troubleshooting steps - H3
76+
77+
Not all known issues can be corrected, but if a solution
78+
is known, describe the steps to take to correct the issue.
79+
80+
-->
81+
82+
### Possible causes
83+
84+
<!-- Optional: Possible causes - H3
85+
86+
In an H3 section, describe potential causes.
87+
88+
-->

0 commit comments

Comments
 (0)