Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme example to import async client #15763

Merged
merged 2 commits into from
Dec 11, 2020
Merged

Update readme example to import async client #15763

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19ff60e
Update readme example to import async client
mccoyp Dec 11, 2020
dc6de31
Update README.md
mccoyp Dec 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions sdk/keyvault/azure-keyvault-certificates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,23 +263,26 @@ for certificate in certificates:
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/master/sdk/core/azure-core/README.md#transport)
[azure-core documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#transport)
for more information.
Async clients should be closed when they're no longer needed. Each async
client is an async context manager and defines an async `close` method. For
example:
```py
from azure.keyvault.certificates import CertificateClient
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.certificates.aio import CertificateClient
credential = DefaultAzureCredential()
# call close when the client is no longer needed
client = CertificateClient()
client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
...
await client.close()
# alternatively, use the client as an async context manager
client = CertificateClient()
client = CertificateClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
async with client:
...
```
Expand Down