WIP: DSC v3 resource for PSResourceGet by adityapatwardhan · Pull Request #1852 · PowerShell/PSResourceGet

adityapatwardhan · 2025-07-28T20:55:50Z

PR Summary

The initial implementation of DSC v3 resource for PSResourceGet. It include two resources, Repository and PSResources.

PR Context

PR Checklist

michaeltlombardi

Quick review pass on the manifests, looking at resource implementation next.

src/dsc/repository.dsc.resource.json

src/dsc/psresources.dsc.resource.json

src/dsc/repository.dsc.resource.json

src/dsc/psresourceget.ps1

src/dsc/psresources.dsc.resource.json

src/dsc/psresourceget.ps1

SteveL-MSFT · 2025-07-28T21:39:53Z

src/dsc/psresourceget.ps1

+            Add-Type -AssemblyName "$PSScriptRoot/dependencies/NuGet.Versioning.dll"
+
+            foreach ($resource in $allPSResources) {
+                foreach ($inputResource in $inputObj.resources) {
+                    if ($resource.Name -eq $inputResource.Name) {
+                        if ($inputResource.Version) {
+                            # Use the NuGet.Versioning package if available, otherwise do a simple comparison
+                            try {
+                                $versionRange = [NuGet.Versioning.VersionRange]::Parse($inputResource.Version)
+                                $resourceVersion = [NuGet.Versioning.NuGetVersion]::Parse($resource.Version.ToString())
+                                if ($versionRange.Satisfies($resourceVersion)) {
+                                    $resourcesExist += $resource
+                                }
+                            }
+                            catch {
+                                # Fallback: simple string comparison (not full NuGet range support)
+                                if ($resource.Version.ToString() -eq $inputResource.Version) {
+                                    $resourcesExist += $resource
+                                }
+                            }
+                        }
+                    }
+                }
+            }


This code seems very similar across different operations, can it be a helper function?

There are subtle differences, but I will see if I can refactor

SteveL-MSFT · 2025-07-28T21:42:11Z

src/dsc/psresourceget.ps1

+            if ($inputObj.Name) {
+                $splatt['Name'] = $inputObj.Name
+            }
+
+            if ($inputObj.Uri) {
+                $splatt['Uri'] = $inputObj.Uri
+            }
+
+            if ($inputObj.Trusted) {
+                $splatt['Trusted'] = $inputObj.Trusted
+            }
+
+            if ($null -ne $inputObj.Priority ) {
+                $splatt['Priority'] = $inputObj.Priority
+            }


Can this just be a loop like:

$properties = @('Name', 'Uri', 'Trusted', 'Priority') for ($property in $properties) { if ($null -ne $inputObject.$property) { $splatt[$property] = $inputObject.$property } }

src/dsc/psresources.dsc.resource.json

michaeltlombardi

A few more comments on the schema and implementation.

michaeltlombardi · 2025-07-28T21:50:04Z

src/dsc/psresourceget.ps1

+        [string]$ResourceType
+    )
+
+    $inputObj = $stdinput | ConvertFrom-Json -ErrorAction Stop


I would probably recommend defining a class for both the various input types and a function to handle both converting the input into the appropriate type and validating the input.

Right now reading $inputObj.<property> and trying to keep track is very difficult, plus we lose the IntelliSense/etc we would get from stronger typing.

src/dsc/psresourceget.ps1

michaeltlombardi · 2025-07-28T21:57:45Z

src/dsc/psresourceget.ps1

+# catch any un-caught exception and write it to the error stream
+trap {
+    Write-Trace -Level Error -message $_.Exception.Message
+    exit 1


Future enhancement - specific exit codes for specific issues/exceptions.

src/dsc/psresources.dsc.resource.json

ThomasNieto · 2025-07-30T02:42:40Z

Is the plan to add a discover extension in DSC to be able to find these resource manifests? If so, is there an issue/pr for that?

ThomasNieto · 2025-07-30T03:43:16Z

src/dsc/psresources.dsc.resource.json

+  "type": "Microsoft.PowerShell.PSResourceGet/PSResources",
+  "version": "0.0.1",
+  "get": {
+    "executable": "pwsh",


How is Windows PowerShell handled? PSResourceGet supports both. For PSScript DSC v3 resource there are actually two different resources to account for different versions of PowerShell.

ThomasNieto · 2025-07-30T03:43:26Z

src/dsc/repository.dsc.resource.json

+    "type": "Microsoft.PowerShell.PSResourceGet/Repository",
+    "version": "0.0.1",
+    "get": {
+        "executable": "pwsh",


How is Windows PowerShell handled? PSResourceGet supports both. For PSScript DSC v3 resource there are actually two different resources to account for different versions of PowerShell.

michaeltlombardi · 2025-07-30T15:55:53Z

Is the plan to add a discover extension in DSC to be able to find these resource manifests? If so, is there an issue/pr for that?

@ThomasNieto yup! PowerShell/DSC#913 proposes a discovery extension for finding resource and extension manifests through the PSModulePath.

ThomasNieto · 2025-08-01T05:05:34Z

I logged PowerShell/DSC#1024 issue. PSResourceGet will also have the same issue since it uses NuGet version range syntax containing square brackets.

Gijsreyn · 2025-11-08T03:02:09Z

@adityapatwardhan - I think you've followed the news, but you should be able to define a single resource manifest now e.g.,:

// psresourceget.dsc.manifests.json
{
  "resources": [
    {
      "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
      "description": "Manage PowerShell resources using PSResourceGet.",
      "tags": [
        "linux",
        "windows",
        "macos",
        "powershell",
        "nuget"
      ],
      "type": "Microsoft.PowerShell.PSResourceGet/PSResourceList",
      "version": "0.0.1",
      "get": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation 'get'"
        ],
        "input": "stdin"
      },
      "set": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation set"
        ],
        "input": "stdin",
        "return": "stateAndDiff"
      },
      "export": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "./psresourceget.ps1 -resourcetype 'psresourcelist' -operation export"
        ],
        "input": "stdin"
      },
      "test": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'psresourcelist' -operation test"
        ],
        "input": "stdin",
        "return": "stateAndDiff"
      },
      "schema": {
        "embedded": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "PSResourceList",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "repositoryName"
          ],
          "properties": {
            "repositoryName": {
              "title": "Repository Name",
              "description": "The name of the repository from where the resources are acquired.",
              "type": "string"
            },
            "resources": {
              "title": "Resources",
              "description": "The list of resources to manage.",
              "type": "array",
              "items": {
                "$ref": "#/$defs/PSResource"
              },
              "minItems": 0
            },
            "_exist": {
              "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json"
            },
            "_inDesiredState": {
              "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json"
            }
          },
          "$defs": {
            "Scope": {
              "type": "string",
              "title": "Scope",
              "description": "Scope of the resource installation.",
              "enum": [
                "CurrentUser",
                "AllUsers"
              ]
            },
            "PSResource": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "name"
              ],
              "properties": {
                "name": {
                  "title": "Name",
                  "description": "The name of the resource.",
                  "type": "string"
                },
                "version": {
                  "title": "Version",
                  "description": "The version range of the resource.",
                  "type": "string",
                  "pattern": "^(\\[|\\()\\s*\\d+(\\.\\d+){0,2}(-[0-9A-Za-z-.]+)?\\s*(,\\s*(\\d+(\\.\\d+){0,2}(-[0-9A-Za-z-.]+)?)?\\s*(\\]|\\)))?$"
                },
                "scope": {
                  "title": "Scope",
                  "description": "The scope of the resource. Can be 'CurrentUser' or 'AllUsers'.",
                  "$ref": "#/$defs/Scope"
                },
                "repositoryName": {
                  "title": "Repository Name",
                  "description": "The name of the repository from where the resource is acquired.",
                  "type": "string"
                },
                "preRelease": {
                  "title": "Pre-Release version",
                  "description": "Indicates whether to include pre-release versions of the resource.",
                  "type": "boolean",
                  "default": false
                },
                "_exist": {
                  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json"
                },
                "_inDesiredState": {
                  "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json"
                }
              }
            },
            "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json",
              "title": "Instance should exist",
              "description": "Indicates whether the DSC resource instance should exist.",
              "type": "boolean",
              "default": true,
              "enum": [
                false,
                true
              ]
            },
            "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/inDesiredState.json",
              "title": "Instance is in desired state",
              "description": "Indicates whether the DSC resource instance is in the desired state.",
              "type": "boolean",
              "default": true,
              "enum": [
                false,
                true
              ]
            }
          }
        }
      }
    },
    {
      "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
      "description": "Manage PowerShell repositories using PSResourceGet.",
      "tags": [
        "linux",
        "windows",
        "macos",
        "powershell",
        "nuget"
      ],
      "type": "Microsoft.PowerShell.PSResourceGet/Repository",
      "version": "0.0.1",
      "get": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'repository' -operation 'get'"
        ],
        "input": "stdin"
      },
      "set": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'repository' -operation set"
        ],
        "input": "stdin"
      },
      "delete": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "$Input | ./psresourceget.ps1 -resourcetype 'repository' -operation delete"
        ],
        "input": "stdin"
      },
      "export": {
        "executable": "pwsh",
        "args": [
          "-NoLogo",
          "-NonInteractive",
          "-NoProfile",
          "-ExecutionPolicy",
          "Bypass",
          "-Command",
          "./psresourceget.ps1 -resourcetype 'repository' -operation export"
        ],
        "input": "stdin"
      },
      "schema": {
        "embedded": {
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "Repository",
          "description": "A PowerShell Resource repository from where to acquire the resources.",
          "type": "object",
          "additionalProperties": false,
          "allOf": [
            {
              "if": {
                "properties": {
                  "_exist": {
                    "const": false
                  }
                }
              },
              "then": {
                "required": [
                  "name"
                ]
              },
              "else": {
                "required": [
                  "name",
                  "uri"
                ]
              }
            }
          ],
          "properties": {
            "name": {
              "title": "Name",
              "description": "The name of the repository.",
              "type": "string"
            },
            "uri": {
              "title": "URI",
              "description": "The URI of the repository.",
              "type": "string",
              "format": "uri"
            },
            "trusted": {
              "title": "Trusted",
              "description": "Indicates whether the repository is trusted.",
              "type": "boolean"
            },
            "priority": {
              "title": "Priority",
              "description": "The priority of the repository. Lower numbers indicate higher priority.",
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            },
            "repositoryType": {
              "title": "Repository Type",
              "description": "The type of the repository.",
              "$ref": "#/$defs/RepositoryType"
            },
            "_exist": {
              "$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json"
            }
          },
          "$defs": {
            "RepositoryType": {
              "type": "string",
              "title": "Repository Type",
              "description": "The type of the repository. Can be 'Unknown', 'V2', 'V3', 'Local', 'NugetServer', or 'ContainerRegistry'.",
              "enum": [
                "Unknown",
                "V2",
                "V3",
                "Local",
                "NugetServer",
                "ContainerRegistry"
              ]
            },
            "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json": {
              "$schema": "https://json-schema.org/draft/2020-12/schema",
              "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json",
              "title": "Instance should exist",
              "description": "Indicates whether the DSC resource instance should exist.",
              "type": "boolean",
              "default": true,
              "enum": [
                false,
                true
              ]
            }
          }
        }
      }
    }
  ]
}

Gijsreyn · 2025-11-08T04:17:09Z

I think the pattern for version should also slightly change to:

"pattern": "^((\\[|\\()[ \\t]*(>=|>|<=|<)?[ \\t]*\\d+(\\.\\d+){0,2}(-[0-9A-Za-z-.]+)?[ \\t]*(,[ \\t]*(>=|>|<=|<)?[ \\t]*(\\d+(\\.\\d+){0,2}(-[0-9A-Za-z-.]+)?)?[ \\t]*)?(\\]|\\))|\\d+(\\.\\d+){0,2}(-[0-9A-Za-z-.]+)?)$"

adityapatwardhan added 6 commits July 28, 2025 13:50

Initial

6191b04

PSresources

aca1d97

PSResources get

2568cc1

Fix get for psresources

bf192e2

Set operations for psresources working

0a3987c

fix enums

c4d1a58

adityapatwardhan requested review from SydneyhSmith, alerickson and anamnavi as code owners July 28, 2025 20:55

adityapatwardhan changed the title ~~DSC v3 resource for PSResourceGet~~ WIP: DSC v3 resource for PSResourceGet Jul 28, 2025

adityapatwardhan marked this pull request as draft July 28, 2025 20:56

Restores setting files

060c083

SteveL-MSFT requested review from mgreenegit, michaeltlombardi and theJasonHelmick July 28, 2025 21:28

michaeltlombardi reviewed Jul 28, 2025

View reviewed changes

SteveL-MSFT requested changes Jul 28, 2025

View reviewed changes

michaeltlombardi reviewed Jul 28, 2025

View reviewed changes

schema updates via CR

5aab0e8

ThomasNieto reviewed Jul 30, 2025

View reviewed changes

adityapatwardhan added 5 commits July 30, 2025 14:22

Schema updates

48081f8

Fix json and add regex

7701b43

Add tags

7d0eaac

Address CR feedback

55ad3ae

update resource names

f319c30

Refactor

dfa7fbf

adityapatwardhan added 2 commits August 5, 2025 15:45

Refactor repository

0880be4

Major refactor

feafc53

ThomasNieto mentioned this pull request Oct 22, 2025

Class-based resource capabilities in module manifest PowerShell/DSC#852

Open

3 tasks

Conversation

adityapatwardhan commented Jul 28, 2025

PR Summary

PR Context

PR Checklist

Uh oh!

michaeltlombardi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

adityapatwardhan Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaeltlombardi left a comment

Choose a reason for hiding this comment

Uh oh!

michaeltlombardi Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaeltlombardi Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ThomasNieto commented Jul 30, 2025

Uh oh!

ThomasNieto Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThomasNieto Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaeltlombardi commented Jul 30, 2025

Uh oh!

ThomasNieto commented Aug 1, 2025

Uh oh!

Gijsreyn commented Nov 8, 2025

Uh oh!

Gijsreyn commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ThomasNieto Jul 30, 2025 •

edited

Loading

ThomasNieto Jul 30, 2025 •

edited

Loading

Gijsreyn commented Nov 8, 2025 •

edited

Loading