docs: Add reference documentation for Microsoft.Windows/Service#1522
Open
Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Open
docs: Add reference documentation for Microsoft.Windows/Service#1522Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Microsoft.Windows/Service#1522Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Microsoft Learn–style reference documentation for the built-in DSC resource Microsoft.Windows/Service, including example docs and a sample configuration file.
Changes:
- Added the main
Microsoft.Windows/Serviceresource reference page (properties, schema, exit codes, links). - Added example documentation for
dsc resource get/dsc resource export. - Added an example DSC configuration document showing how to configure service status/start type.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference/resources/Microsoft/Windows/Service/index.md | New reference page for the Microsoft.Windows/Service resource (metadata, properties, schema, exit codes). |
| docs/reference/resources/Microsoft/Windows/Service/examples/service.config.dsc.yaml | Sample configuration document defining two Microsoft.Windows/Service instances. |
| docs/reference/resources/Microsoft/Windows/Service/examples/get-service-status.md | Example page demonstrating dsc resource get and dsc resource export. |
| docs/reference/resources/Microsoft/Windows/Service/examples/configure-windows-service.md | Example page demonstrating how to apply a configuration document with dsc config test/set. |
| The configuration document for this example defines two instances of the `Service` resource. | ||
|
|
||
| The first instance ensures that the Windows Update service (`wuauserv`) is stopped and configured | ||
| for manual start. The second instance ensures that the Windows Time service (`w32tm`) is running |
Comment on lines
+81
to
+82
| DSC emits one JSON object per service to stdout. You can pipe the output to a file or process it | ||
| further with other tools. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This pull request adds reference documentation for the built-in DSC resource
Microsoft.Windows/Service. I've tried to do my best to follow proper syntax to easily get it merged on Microsoft Learn + redacted/omitted data to make it life version independently.