Skip to content

Commit dda0bb9

Browse files
Referenced async requirements in readmes (Azure#21966)
* settings files * gitignore * added async readme
1 parent ce9fbbe commit dda0bb9

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed

sdk/storage/azure-storage-blob/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,16 @@ Four different clients are provided to interact with the various components of t
184184
this client represents lease interactions with a `ContainerClient` or `BlobClient`. It provides operations to
185185
acquire, renew, release, change, and break a lease on a specified resource.
186186

187+
### Async Clients
188+
This library includes a complete async API supported on Python 3.5+. To use it, you must
189+
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
190+
See
191+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
192+
for more information.
193+
194+
Async clients and credentials should be closed when they're no longer needed. These
195+
objects are async context managers and define async `close` methods.
196+
187197
### Blob Types
188198
Once you've initialized a Client, you can choose from the different types of blobs:
189199
* [Block blobs](https://docs.microsoft.com/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs#about-block-blobs)

sdk/storage/azure-storage-file-datalake/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,16 @@ DataLake storage offers four types of resources:
7777
* A directory under the file system
7878
* A file in a the file system or under directory
7979

80+
### Async Clients
81+
This library includes a complete async API supported on Python 3.5+. To use it, you must
82+
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
83+
See
84+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
85+
for more information.
86+
87+
Async clients and credentials should be closed when they're no longer needed. These
88+
objects are async context managers and define async `close` methods.
89+
8090
#### Clients
8191

8292
The DataLake Storage SDK provides four different clients to interact with the DataLake Service:

sdk/storage/azure-storage-file-share/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,16 @@ The following components make up the Azure File Share Service:
127127
The Azure Storage File Share client library for Python allows you to interact with each of these components through the
128128
use of a dedicated client object.
129129

130+
### Async Clients
131+
This library includes a complete async API supported on Python 3.5+. To use it, you must
132+
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
133+
See
134+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
135+
for more information.
136+
137+
Async clients and credentials should be closed when they're no longer needed. These
138+
objects are async context managers and define async `close` methods.
139+
130140
### Clients
131141
Four different clients are provided to interact with the various components of the File Share Service:
132142
1. [ShareServiceClient](https://aka.ms/azsdk-python-storage-fileshare-shareserviceclient) -

sdk/storage/azure-storage-queue/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,16 @@ The following components make up the Azure Queue Service:
151151
The Azure Storage Queues client library for Python allows you to interact with each of these components through the
152152
use of a dedicated client object.
153153

154+
### Async Clients
155+
This library includes a complete async API supported on Python 3.5+. To use it, you must
156+
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
157+
See
158+
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
159+
for more information.
160+
161+
Async clients and credentials should be closed when they're no longer needed. These
162+
objects are async context managers and define async `close` methods.
163+
154164
### Clients
155165
Two different clients are provided to interact with the various components of the Queue Service:
156166
1. [QueueServiceClient](https://aka.ms/azsdk-python-storage-queue-queueserviceclient) -

0 commit comments

Comments
 (0)