add ConfigurationIgnoreAttribute to docs - #55757
Open
rosebyte wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the main .NET configuration guidance to document ConfigurationIgnoreAttribute, explaining how both reflection-based binding and the configuration source generator can skip attributed properties.
Changes:
- Adds a new “Exclude properties from binding” advanced binding scenario section.
- Introduces an example showing how to prevent binding from populating a specific property.
- Updates the article date and adds the new section to the in-page navigation list.
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
gewarren
approved these changes
Aug 27, 2026
svick
approved these changes
Aug 28, 2026
|
|
||
| #### Exclude properties from binding | ||
|
|
||
| If you don't want the configuration binder to populate a property, apply <xref:Microsoft.Extensions.Configuration.ConfigurationIgnoreAttribute> to it (available starting in .NET 11). Both the reflection-based binder and the [configuration source generator](configuration-generator.md) honor this attribute. |
Member
There was a problem hiding this comment.
I think both binders supporting a feature should be the default that doesn't need to be mentioned. But I'm fine with keeping it as is.
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.
Summary
Document
ConfigurationIgnoreAttributein the main .NET configuration guidance. Explain that reflection-based and source-generated binding skip attributed properties, and add an example.Related to dotnet/runtime#126396 and dotnet/runtime#125111.
Internal previews
Build report