Enable resources to return _restartRequired metadata #975
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR enables resources to return _restartRequired metadata to indicate what needs to be restarted after configuration operations (system, services, or processes). The metadata is both attached to individual resource results and aggregated at the top-level Microsoft.DSC metadata.
- Adds new
RestartRequiredenum with variants for system, service, and process restart requirements - Integrates restart metadata collection into the configuration context and result processing
- Extends CLI schema output to support the new restart-required type
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| dsc_lib/src/configure/config_doc.rs | Defines RestartRequired enum and Process struct, adds restart_required field to MicrosoftDscMetadata |
| dsc_lib/src/configure/context.rs | Adds restart_required field to Context struct for aggregating restart metadata |
| dsc_lib/src/configure/mod.rs | Updates metadata processing to handle _restartRequired and aggregate it in context |
| dsc_lib/locales/en-us.toml | Adds localization string for invalid restart required metadata warning |
| dsc/src/args.rs | Adds RestartRequired variant to DscType enum |
| dsc/src/util.rs | Adds schema generation support for RestartRequired type |
| dsc/tests/dsc_metadata.tests.ps1 | Comprehensive test coverage for restart required metadata functionality |
SteveL-MSFT
force-pushed
the
restart-required
branch
from
e0dfe06 to
ce9d542
Compare
tgauth
reviewed
Jul 18, 2025
tgauth
reviewed
Jul 18, 2025
tgauth
approved these changes
Jul 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Allow resources to return
_restartRequiredas part of_metadata. This is an array that can contain any of:{ "system": "computerName" }{ "service": "serviceName" }{ "process": { "name": "processName", "id": "pid" } }The metadata is pulled into each resources metadata as part of result object, but also collected into the top level
Microsoft.DSCmetadata:Any items in the array that don't conform to the above results in a warning.
dsc schema -t restart-requiredreturns the JSONSchema.PR Context
Fix #50