Open
feat(azure-core): add azure-deprecating to default HTTP logging allowlist#48286
azure-deprecating to default HTTP logging allowlist#48286Conversation
|
Azure Pipelines: 10 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` response header to the list of default allowed headers in `HttpLoggingPolicy` so it is logged without redaction. 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 Azure Core logging to allow azure-deprecating header
feat(azure-core): add Jul 27, 2026
azure-deprecating to default HTTP logging allowlist
heaths
marked this pull request as ready for review
July 27, 2026 22:07
|
Azure Pipelines: Successfully started running 3 pipeline(s). 7 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
Adds Azure’s deprecation notification header to HTTP logging for improved migration diagnostics.
Changes:
- Allows
azure-deprecatingvalues in HTTP logs. - Adds regression coverage and release notes.
Show a summary per file
| File | Description |
|---|---|
azure/core/pipeline/policies/_universal.py |
Adds the header to the default allowlist. |
tests/test_pipeline.py |
Verifies default header allowance. |
CHANGELOG.md |
Documents the feature for 1.42.0. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Medium
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 fromHttpLoggingPolicy.DEFAULT_HEADERS_ALLOWLIST, causing the deprecation notification response header to be redacted in logs. Per the Azure API guidelines on deprecating behavior notification, this header should be visible to aid debugging and service migration. This change was requested by Heath Stewart.Changes
azure/core/pipeline/policies/_universal.py: Added"azure-deprecating"toDEFAULT_HEADERS_ALLOWLISTinHttpLoggingPolicy.tests/test_pipeline.py: Added assertion thatazure-deprecatingis present in the default allowed header names.CHANGELOG.md: Added entry under new1.42.0 (Unreleased)section.