Add doc for the envs supported in azure-core#45975
Merged
xiangyan99 merged 7 commits intomainfrom Mar 31, 2026
Merged
Conversation
pvaneck
reviewed
Mar 30, 2026
Co-authored-by: Paul Van Eck <paulvaneck@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/centralizes documentation for environment variables used by azure-core (settings, tracing, HTTP pipeline behavior, and proxy configuration) and surfaces that information in developer-facing docs and docstrings.
Changes:
- Added a new
ENVIRONMENT_VARIABLES.mdreference doc enumerating supported environment variables. - Added an “Environment Variables” section to
CLIENT_LIBRARY_DEVELOPER.mdand cross-referenced it from the proxy settings discussion. - Updated docstrings in
Settings, transports, and pipeline policies to explicitly mention relevant environment variables.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/core/azure-core/ENVIRONMENT_VARIABLES.md | New reference document for azure-core environment variables. |
| sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md | Adds an Environment Variables section and updates proxy-settings docs to include NO_PROXY and link to env var info. |
| sdk/core/azure-core/azure/core/settings.py | Extends Settings documentation to include AZURE_SDK_CLOUD_CONF and a summary of settings-related env vars. |
| sdk/core/azure-core/azure/core/pipeline/transport/_requests_basic.py | Documents proxy-related env vars honored when use_env_settings=True. |
| sdk/core/azure-core/azure/core/pipeline/transport/_aiohttp.py | Documents proxy-related env vars honored when use_env_settings=True. |
| sdk/core/azure-core/azure/core/pipeline/policies/_universal.py | Documents AZURE_HTTP_USER_AGENT and AZURE_SDK_LOGGING_MULTIRECORD env vars in policy docstrings. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
pvaneck
reviewed
Mar 31, 2026
Co-authored-by: Paul Van Eck <paulvaneck@microsoft.com>
Co-authored-by: Paul Van Eck <paulvaneck@microsoft.com>
pvaneck
approved these changes
Mar 31, 2026
Member
Author
|
/check-enforcer override |
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.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines