Skip to content

Commit

Permalink
Referenced async requirements in readmes (#21966)
Browse files Browse the repository at this point in the history
* settings files

* gitignore

* added async readme
  • Loading branch information
tasherif-msft authored Dec 22, 2021
1 parent ce9fbbe commit dda0bb9
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 0 deletions.
10 changes: 10 additions & 0 deletions sdk/storage/azure-storage-blob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,16 @@ Four different clients are provided to interact with the various components of t
this client represents lease interactions with a `ContainerClient` or `BlobClient`. It provides operations to
acquire, renew, release, change, and break a lease on a specified resource.

### Async Clients
This library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.

Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async `close` methods.

### Blob Types
Once you've initialized a Client, you can choose from the different types of blobs:
* [Block blobs](https://docs.microsoft.com/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs#about-block-blobs)
Expand Down
10 changes: 10 additions & 0 deletions sdk/storage/azure-storage-file-datalake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ DataLake storage offers four types of resources:
* A directory under the file system
* A file in a the file system or under directory

### Async Clients
This library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.

Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async `close` methods.

#### Clients

The DataLake Storage SDK provides four different clients to interact with the DataLake Service:
Expand Down
10 changes: 10 additions & 0 deletions sdk/storage/azure-storage-file-share/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,16 @@ The following components make up the Azure File Share Service:
The Azure Storage File Share client library for Python allows you to interact with each of these components through the
use of a dedicated client object.

### Async Clients
This library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.

Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async `close` methods.

### Clients
Four different clients are provided to interact with the various components of the File Share Service:
1. [ShareServiceClient](https://aka.ms/azsdk-python-storage-fileshare-shareserviceclient) -
Expand Down
10 changes: 10 additions & 0 deletions sdk/storage/azure-storage-queue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,16 @@ The following components make up the Azure Queue Service:
The Azure Storage Queues client library for Python allows you to interact with each of these components through the
use of a dedicated client object.

### Async Clients
This library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such as [aiohttp](https://pypi.org/project/aiohttp/).
See
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.

Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async `close` methods.

### Clients
Two different clients are provided to interact with the various components of the Queue Service:
1. [QueueServiceClient](https://aka.ms/azsdk-python-storage-queue-queueserviceclient) -
Expand Down

0 comments on commit dda0bb9

Please sign in to comment.