diff --git a/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md b/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md index cd8837b4a422..d4df0b656070 100644 --- a/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md +++ b/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md @@ -142,6 +142,40 @@ transport = AioHttpTransport( ) ``` +### Proxy Settings + +There are two ways to configure proxy settings. + +- Use environment proxy settings + +When creating the transport, "use_env_settings" parameter can be used to enable or disable the environment proxy settings. e.g.: + +```python +synchronous_transport = RequestsTransport(use_env_settings=True) +``` + +If "use_env_settings" is set to True(by default), the transport will look for environment variables + +- HTTP_PROXY +- HTTPS_PROXY + +and use their values to configure the proxy settings. + +- Use ProxyPolicy + +You can use ProxyPolicy to configure the proxy settings as well. e.g. + +```python +from azure.core.pipeline.policies import ProxyPolicy + +proxy_policy = ProxyPolicy() + +proxy_policy.proxies = {'http': 'http://10.10.1.10:3148'} + +# Use basic auth +proxy_policy.proxies = {'https': 'http://user:password@10.10.1.10:1180/'} +``` + ### HttpRequest and HttpResponse The HttpRequest and HttpResponse objects represent a generic concept of HTTP request and response constructs and are in no way tied to a particular transport or HTTP library.