Skip to content

Commit 67ae873

Browse files
committed
Document additional env vars
1 parent 38218d4 commit 67ae873

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

docs/azure/sdk/configure-proxy.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,21 @@ Using the Azure Key Vault Secrets library as an example, you'd have the followin
2929

3030
## Configure using environment variables
3131

32-
Depending on whether your proxy server uses HTTP or HTTPS, set either the environment variable `HTTP_PROXY` or `HTTPS_PROXY`, respectively. The proxy server URL takes the form `http[s]://[username:password@]<ip_address_or_hostname>:<port>/`, where the `username:password` combination is optional. To get the IP address or hostname, port, and credentials for your proxy server, consult your network administrator.
32+
The following table provides an inventory of environment variables that can be set to configure a proxy for use.
33+
34+
| Environment variable | Purpose |
35+
|----------------------|--------------------------------------------------------------------------------------------------------------|
36+
| `HTTP_PROXY` | The proxy server used on HTTP requests. |
37+
| `HTTPS_PROXY` | The proxy server used on HTTPS requests. |
38+
| `ALL_PROXY` | The proxy server used for both HTTP and HTTPS requests, in case `HTTP_PROXY` or `HTTPS_PROXY` are undefined. |
39+
| `NO_PROXY` | A comma-delimited list of hostnames to exclude from proxying. |
40+
41+
Be aware of the following behaviors:
42+
43+
- Each environment variable in the preceding table can alternatively be defined as lowercase. For example, `http_proxy`. The lowercase form takes precedence over the uppercase form.
44+
- Protocol-specific environment variables take precedence over `ALL_PROXY`.
45+
46+
The proxy server URL takes the form `http[s]://[username:password@]<ip_address_or_hostname>:<port>/`, where the `username:password` combination is optional. To get the IP address or hostname, port, and credentials for your proxy server, consult your network administrator.
3347

3448
The following examples show how to set the appropriate environment variables in command shell (Windows) and bash (Linux/macOS) environments. Setting the appropriate environment variable causes the Azure SDK for .NET libraries to use the proxy server at runtime.
3549

@@ -43,10 +57,10 @@ rem Authenticated HTTP server:
4357
set HTTP_PROXY=http://username:[email protected]:1180
4458
4559
rem Non-authenticated HTTPS server:
46-
set HTTPS_PROXY=http://10.10.1.10:1180
60+
set HTTPS_PROXY=https://10.10.1.10:1180
4761
4862
rem Authenticated HTTPS server:
49-
set HTTPS_PROXY=http://username:[email protected]:1180
63+
set HTTPS_PROXY=https://username:[email protected]:1180
5064
```
5165

5266
### [bash](#tab/bash)
@@ -59,10 +73,10 @@ HTTP_PROXY=http://10.10.1.10:1180
5973
HTTP_PROXY=http://username:[email protected]:1180
6074

6175
# Non-authenticated HTTPS server:
62-
HTTPS_PROXY=http://10.10.1.10:1180
76+
HTTPS_PROXY=https://10.10.1.10:1180
6377

6478
# Authenticated HTTPS server:
65-
HTTPS_PROXY=http://username:[email protected]:1180
79+
HTTPS_PROXY=https://username:[email protected]:1180
6680
```
6781

6882
---

0 commit comments

Comments
 (0)