Add Registry Adapter and `Microsoft.Windows/Personalization` resource by SteveL-MSFT · Pull Request #1550 · PowerShell/DSC

SteveL-MSFT · 2026-05-30T00:00:37Z

PR Summary

Fix DSC engine to use adapted resource schema instead of validate function of adapter
Refactor DSC engine to pass the DscResource instead of a different struct CommandResourceInfo when invoking a native resource as information for specific arg types comes from the resource properties, this simplifies the code and future extensibility (basically all the command_resource changes are this which was needed to add the new adaptedContentArg type
Add new content property that can be used in adapted resource manifest instead of path to have inline structured content for an adapter
Add new adapter mode to Registry resource that uses this content property
Add new Microsoft.Windows/Personalization resource that uses the registry adapter
The adapter itself has helpers for converting fron JSON to registry and vice versa. Note that not all types were implemented, only ones used by the Personalization resource. More conversions will be added if we have real use cases for them.

The Microsoft.Windows/Personalization adapted resource manifest best shows how to use this adapter:

# Adapted Registry resource for personalization settings defined in:
# https://learn.microsoft.com/en-us/windows/apps/develop/settings/settings-common#personalization---colors

$schema: https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json
type: Microsoft.Windows/Personalization
kind: resource
version: 1.0.0
capabilities:
- get
- set
description: Controls Windows personalization settings such as accent color, light/dark mode, and transparency effects.
author: Microsoft Corporation
requireAdapter: Microsoft.Windows.Adapter/Registry
content:
  appsUseLightTheme:
    keyPath: HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Themes\Personalize
    valueType: REG_DWORD
    valueName: AppsUseLightTheme
    jsonType: boolean
    defaultValueIfNotFound: 0
    mapJsonToRegistry:
      'false': 0
      'true': 1
schema:
  embedded:
    $schema: http://json-schema.org/draft-07/schema#
    $id: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/resources/Adapted/Three/v0.1.0/schema.json
    title: Microsoft.Windows/Personalization
    description: Windows personalization settings such as accent color, light/dark mode, and transparency effects as described in https://learn.microsoft.com/windows/apps/develop/settings/settings-common
    type: object
    required: []
    additionalProperties: false
    properties:
      appsUseLightTheme:
        type: boolean
        title: App Uses Light Theme
        description: Indicates whether the app uses the light theme.

The content is used by the registry adapter to map the JSON to registry key path/value/valueName/type. There is also a default value used if the key or value doesn't exist in the registry. The JSONSchema is used to enforce what is allowed.

Schema for content retrieved via registry adapter schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AdaptedRegistryValue",
  "type": "object",
  "properties": {
    "keyPath": {
      "type": "string"
    },
    "valueName": {
      "type": "string"
    },
    "valueType": {
      "$ref": "#/$defs/RegistryDataType"
    },
    "jsonType": {
      "$ref": "#/$defs/JsonType"
    },
    "mapJsonToRegistry": true,
    "defaultValueIfNotFound": true
  },
  "required": [
    "keyPath",
    "valueName",
    "valueType",
    "jsonType",
    "mapJsonToRegistry",
    "defaultValueIfNotFound"
  ],
  "$defs": {
    "RegistryDataType": {
      "type": "string",
      "enum": [
        "REG_BINARY",
        "REG_DWORD",
        "REG_EXPAND_SZ",
        "REG_MULTI_SZ",
        "REG_SZ",
        "REG_QWORD"
      ]
    },
    "JsonType": {
      "type": "string",
      "enum": [
        "boolean",
        "booleanArray",
        "number",
        "numberArray",
        "string",
        "stringArray"
      ]
    }
  }
}

PR Context

Copilot

Pull request overview

Adds a new Windows Registry adapter (Microsoft.Windows.Adapter/Registry) plus an inline content shape for adapted resource manifests so adapters can receive structured mapping data directly. Uses the new mechanism to ship a Microsoft.Windows/Personalization adapted resource, and refactors command invocation in dsc-lib to pass DscResource directly instead of a separate CommandResourceInfo struct.

Changes:

New manifest enum AdaptedPathOrContent (path or inline content), plumbed through discovery and stored on DscResource.adapted_content; new adaptedContentArg arg kind for get/set/delete; Adapter.list made optional.
New registry adapter (adapter.rs, adapter subcommand, locale strings, manifest entry, error type) with JSON↔registry conversions for a subset of value types.
New Microsoft.Windows/Personalization adapted YAML manifest, project data, and Pester get/set/export tests; refactor of command_resource.rs / extensions/discover.rs to drop CommandResourceInfo; get_schema now prefers the target resource’s schema.

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
lib/dsc-lib/src/dscresources/adapted_resource_manifest.rs	Adds `AdaptedPathOrContent` enum and flattens into manifest.
lib/dsc-lib/src/dscresources/dscresource.rs	Adds `adapted_content` field to `DscResource`.
lib/dsc-lib/src/dscresources/resource_manifest.rs	Adds `AdaptedContent` arg kinds; makes `Adapter.list` optional.
lib/dsc-lib/src/dscresources/command_resource.rs	Drops `CommandResourceInfo`, threads `DscResource` directly; handles new arg kinds; reworks `get_schema`.
lib/dsc-lib/src/discovery/command_discovery.rs	Loads `content` vs `path`; gates list invocation on optional `list`.
lib/dsc-lib/src/extensions/discover.rs	Switches to passing a `DscResource` for arg processing.
lib/dsc-lib/locales/en-us.toml	Adds `noAdaptedContent` localization string.
lib/dsc-lib-jsonschema/.versions.json	Bumps latest patch to `V3_2_1`.
tools/test_group_resource/src/main.rs	Initializes new `adapted_content` field.
resources/registry/Cargo.toml, Cargo.lock	Version bump to 1.1.0.
resources/registry/src/main.rs	Wires up new `adapter` subcommand.
resources/registry/src/args.rs	Adds `AdapterSubCommand` and `SubCommand::Adapter`.
resources/registry/src/adapter.rs	New adapter implementation and JSON↔registry conversions.
resources/registry/src/error.rs	New `RegistryResourceError` type.
resources/registry/registry.dsc.manifests.json	Adds `Microsoft.Windows.Adapter/Registry` adapter manifest.
resources/registry/locales/en-us.toml	Adds adapter localization strings.
resources/windows_personalization/windows_personalization.dsc.adaptedResource.yaml	New Personalization adapted resource with content map and embedded schema.
resources/windows_personalization/.project.data.json	Build copy-files entry for Windows.
resources/windows_personalization/personalization_{get,set,export}.tests.ps1	New Pester tests for the Personalization resource.

michaeltlombardi · 2026-06-11T20:59:44Z

+#[derive(Debug, Deserialize)]
+enum RegistryDataType {
+    #[serde(rename = "REG_BINARY")]
+    Binary,
+    #[serde(rename = "REG_DWORD")]
+    Dword,
+    #[serde(rename = "REG_EXPAND_SZ")]
+    ExpandString,
+    #[serde(rename = "REG_MULTI_SZ")]
+    MultiString,
+    #[serde(rename = "REG_SZ")]
+    String,
+    #[serde(rename = "REG_QWORD")]
+    Qword,
+}


This holds for all of the new structs, but I think we need to derive JSON Schema for these types and make sure we can export those / surface from the CLI / document them.

Eventually we want to be able to define this in the adapter's manifest so tools can validate the adapted resource manifest.

Added registry adapter schema subcommand

tgauth · 2026-06-12T20:34:09Z

+getProcessingKey = "Processing key: %{key}"
+getNoAdaptedRegistryValueFound = "No adapted registry value found for key: %{key}"
+setProcessingKey = "Setting key: %{key}"
+setNoAdaptedRegistryValueFound = "No adapted registry value found for key: %{key}"


Can getNoAdaptedRegistryValueFound and setNoAdaptedRegistryValueFound be consolidated into a single noAdaptedRegistryValueFound since they have the exact same message?

tgauth · 2026-06-12T20:35:54Z

+use tracing::{debug, trace, warn};
+
+#[derive(Deserialize)]
+struct AdaptedRegistryResource {


Is the AdaptedRegistryResource struct definition necessary here for just a Map<String, Value> since properties is being flattened?

SteveL-MSFT requested review from Copilot and tgauth May 30, 2026 00:00

SteveL-MSFT added Doc-Impact Schema-Impact Change requires updating a canonical schema for configs or manifests labels May 30, 2026

Copilot started reviewing on behalf of SteveL-MSFT May 30, 2026 00:00 View session

Steve Lee (POWERSHELL HE/HIM) (from Dev Box) added 10 commits May 29, 2026 17:01

Initial work for registry adapter

c8febcc

Enable adaptedContent and registry adapter

db7f916

updating adapter

d1be78c

fix values as strings

bee59d0

rebase

1833ad5

fix merge conflict

a9cbb70

fix mapping from json to registry and vice versa

8e59d7a

Fix export to work add tests

bad2fa7

add support for set

a3282e0

clippy and loc fixes

e604361

SteveL-MSFT force-pushed the registry-adapter branch from 41f6226 to e604361 Compare May 30, 2026 00:01

Copilot AI reviewed May 30, 2026

View reviewed changes

SteveL-MSFT marked this pull request as draft May 30, 2026 00:23

Steve Lee (POWERSHELL HE/HIM) (from Dev Box) added 5 commits May 29, 2026 17:47

fix copilot feedback

5b8297b

fix schema retrieval for adapted resources

7cd1aa7

fix validation

7dd1cd7

fix working directory for command invocation

594971f

fix loc strings

ca4cb07

SteveL-MSFT marked this pull request as ready for review May 30, 2026 05:36

SteveL-MSFT changed the title ~~Add Registry Adapter~~ Add Registry Adapter and Microsoft.Windows/Personalization resource May 30, 2026

fix tests

0f05b2a

michaeltlombardi reviewed Jun 11, 2026

View reviewed changes

Add registry adapter schema command

10b0c2b

tgauth reviewed Jun 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Registry Adapter and `Microsoft.Windows/Personalization` resource#1550

Add Registry Adapter and `Microsoft.Windows/Personalization` resource#1550
SteveL-MSFT wants to merge 17 commits into
PowerShell:mainfrom
SteveL-MSFT:registry-adapter

SteveL-MSFT commented May 30, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaeltlombardi Jun 11, 2026

Uh oh!

SteveL-MSFT Jun 11, 2026

Uh oh!

tgauth Jun 12, 2026

Uh oh!

tgauth Jun 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

SteveL-MSFT commented May 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaeltlombardi Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

tgauth Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

tgauth Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

SteveL-MSFT commented May 30, 2026 •

edited

Loading