{{ message }}
Repository navigation
Docs file content dsc resource - #1764
Open
Michal Machniak (mimachniak) wants to merge 7 commits into
Open
Michal Machniak (mimachniak) wants to merge 7 commits into
Michal Machniak (mimachniak) wants to merge 7 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The multiline example needs bracket escaping, and the export guidance must acknowledge DSC's Get fallback.
2 open issues
What changed in this PR
Adds reference documentation and usage examples for managing local file content with Microsoft.Filesystem.File/Content.
Changes:
- Documents properties, schema, capabilities, and exit codes.
- Adds examples for reading, testing, setting, and removing content.
- Provides simple and multiline YAML configurations.
Review effort: Balanced
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
Add reference documentation for the Microsoft.Filesystem.File/Content DSC resource, including its properties, schema, capabilities, and exit codes. Add examples for getting, testing, setting, and removing file content, plus a configuration that uses _exist: true and a YAML literal block to create a file with multiline content.
PR Context
This documentation helps users understand how to manage local file content with DSC, including how to create missing parent directories, verify file state, and represent complex file content in a configuration. It also clarifies that the resource doesn’t support export.