Skip to content

Commit 2e94c50

Browse files
authored
add transport docs in readme (Azure#15856)
* add transport docs in readme * remove Transport configurations from dev doc
1 parent a98bd20 commit 2e94c50

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -151,19 +151,6 @@ transport = AioHttpTransport(
151151
)
152152
```
153153

154-
#### Transport configurations
155-
156-
| Parameters | Description |
157-
| --- | --- |
158-
| connection_timeout | A single float in seconds for the connection timeout. Defaults to 300 seconds. |
159-
| read_timeout | A single float in seconds for the read timeout. Defaults to 300 seconds. |
160-
| connection_verify | SSL certificate verification. Enabled by default. Set to False to disable, alternatively can be set to the path to a CA_BUNDLE file or directory with certificates of trusted CAs. |
161-
| connection_cert | Client-side certificates. You can specify a local cert to use as client side certificate, as a single file (containing the private key and the certificate) or as a tuple of both files' paths. |
162-
| proxies | Dictionary mapping protocol or protocol and hostname to the URL of the proxy. |
163-
| cookies | Dict or CookieJar object to send with the `Request`. |
164-
| stream | whether to immediately download the response content. Defaults to ``False``. |
165-
| connection_data_block_size | The block size of data sent over the connection. Defaults to 4096 bytes. |
166-
167154
### Proxy Settings
168155

169156
There are two ways to configure proxy settings.

sdk/core/azure-core/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,28 @@ class TooManyRedirectsError(HttpResponseError):
112112

113113
*kwargs* are keyword arguments to include with the exception.
114114

115+
### Transport
116+
117+
Some common properties can be configured on transports. They must be passed
118+
as kwargs arguments while building the transport instance.
119+
120+
#### Transport configurations
121+
122+
| Parameters | Description |
123+
| --- | --- |
124+
| connection_timeout | A single float in seconds for the connection timeout. Defaults to 300 seconds. |
125+
| read_timeout | A single float in seconds for the read timeout. Defaults to 300 seconds. |
126+
| connection_verify | SSL certificate verification. Enabled by default. Set to False to disable, alternatively can be set to the path to a CA_BUNDLE file or directory with certificates of trusted CAs. |
127+
| connection_cert | Client-side certificates. You can specify a local cert to use as client side certificate, as a single file (containing the private key and the certificate) or as a tuple of both files' paths. |
128+
| proxies | Dictionary mapping protocol or protocol and hostname to the URL of the proxy. |
129+
| cookies | Dict or CookieJar object to send with the `Request`. |
130+
| stream | whether to immediately download the response content. Defaults to ``False``. |
131+
| connection_data_block_size | The block size of data sent over the connection. Defaults to 4096 bytes. |
132+
133+
#### Async transport
134+
135+
The async transport is designed to be opt-in. [AioHttp](https://pypi.org/project/aiohttp/) is one of the supported implementations of async transport. It is not installed by default. You need to install it separately.
136+
115137
### Shared modules
116138

117139
#### MatchConditions

0 commit comments

Comments
 (0)