Open
feat(core): add azure-deprecating to default allowed HTTP headers#7246
azure-deprecating to default allowed HTTP headers#7246Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Add `azure-deprecating` to `g_defaultAllowedHttpHeaders` so this response header is logged without redaction by the HTTP pipeline. Update tests and CHANGELOG accordingly. See https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#deprecating-behavior-notification Co-authored-by: heaths <1532486+heaths@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update logging defaults to allow azure-deprecating response header
feat(core): add Jul 27, 2026
azure-deprecating to default allowed HTTP headers
heaths
marked this pull request as ready for review
July 27, 2026 22:07
|
Azure Pipelines: Successfully started running 2 pipeline(s). 8 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Azure Core’s HTTP pipeline logging sanitizer defaults so the azure-deprecating header value is no longer redacted in diagnostics, aligning with Azure API Guidelines deprecation notifications.
Changes:
- Added
azure-deprecatingto the default allowed (unsanitized) HTTP header allow-list used byLogPolicy/HttpSanitizer. - Updated
LogPolicy.DefaultHeadersunit test helper and expected logged header output to includeazure-deprecating. - Added a release note entry for the change in
sdk/core/azure-core/CHANGELOG.md.
Show a summary per file
| File | Description |
|---|---|
| sdk/core/azure-core/src/http/log_policy.cpp | Adds azure-deprecating to the default allowed header set so it won’t be redacted in logs. |
| sdk/core/azure-core/test/ut/log_policy_test.cpp | Extends the default-header logging test to exercise and assert azure-deprecating output. |
| sdk/core/azure-core/CHANGELOG.md | Documents the new default-allowed header in release notes. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Low
|
|
||
| ### Features Added | ||
|
|
||
| - Added `azure-deprecating` to the default list of allowed (unsanitized) HTTP response headers logged by the HTTP pipeline. See [Azure API guidelines: Deprecating Behavior Notification](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#deprecating-behavior-notification) for more information. |
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.
azure-deprecatingwas missing from the default allowed (unsanitized) header list in Azure Core's HTTP pipeline logging/sanitizer, causing its value to be redacted (REDACTED) in logs. Per Azure API Guidelines: Deprecating Behavior Notification, this header carries human-readable deprecation notices that should be visible in diagnostics.Requested by Heath Stewart (@heaths).
Changes
sdk/core/azure-core/src/http/log_policy.cpp— Added"azure-deprecating"tog_defaultAllowedHttpHeaders(alphabetically betweenAccept-RangesandCache-Control).sdk/core/azure-core/test/ut/log_policy_test.cpp— Addedazure-deprecatingto theSendRequesttest helper and updatedLogPolicy.Headersexpected output.sdk/core/azure-core/CHANGELOG.md— Added entry underFeatures Addedfor1.17.0-beta.1.Pull Request Checklist
Please leverage this checklist as a reminder to address commonly occurring feedback when submitting a pull request to make sure your PR can be reviewed quickly:
See the detailed list in the contributing guide.