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

[key vault] doc changes #13004

Merged
merged 3 commits into from
Aug 10, 2020
Merged

[key vault] doc changes #13004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f28964
doc changes
iscai-msft Aug 10, 2020
3bd72c1
Merge branch 'master' of https://github.com/Azure/azure-sdk-for-pytho…
iscai-msft Aug 10, 2020
c50443b
implementing charles' suggestion for param descriptions
iscai-msft Aug 10, 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
2 changes: 1 addition & 1 deletion sdk/keyvault/azure-keyvault-keys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ This section contains code snippets covering common tasks:
* [Update an existing Key](#update-an-existing-key "Update an existing Key")
* [Delete a Key](#delete-a-key "Delete a Key")
* [List Keys](#list-keys "List Keys")
* [Perform cryptographic operations](#cryptographic-operations)
* [Asynchronously create a Key](#asynchronously-create-a-key "Asynchronously create a Key")
* [Asynchronously list Keys](#asynchronously-list-keys "Asynchronously list Keys")
* [Perform cryptographic operations](#cryptographic-operations)

### Create a Key
[create_rsa_key](https://aka.ms/azsdk/python/keyvault-keys/docs#azure.keyvault.keys.KeyClient.create_rsa_key) and
Expand Down
5 changes: 3 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,9 @@ def verify(self, algorithm, digest, signature, **kwargs):

:param algorithm: verification algorithm
:type algorithm: :class:`~azure.keyvault.keys.crypto.SignatureAlgorithm`
:param bytes digest:
:param bytes signature:
:param bytes digest: Pre-hashed digest corresponding to **signature**. The hash algorithm used must be
compatible with **algorithm**.
:param bytes signature: signature to verify
:rtype: :class:`~azure.keyvault.keys.crypto.VerifyResult`

Example:
Expand Down
5 changes: 3 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/aio/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,9 @@ async def verify(

:param algorithm: verification algorithm
:type algorithm: :class:`~azure.keyvault.keys.crypto.SignatureAlgorithm`
:param bytes digest:
:param bytes signature:
:param bytes digest: Pre-hashed digest corresponding to **signature**. The hash algorithm used must be
compatible with **algorithm**.
:param bytes signature: signature to verify
:rtype: :class:`~azure.keyvault.keys.crypto.VerifyResult`

Example:
Expand Down
2 changes: 1 addition & 1 deletion sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/aio/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ async def backup_secret(self, name: str, **kwargs: "Any") -> bytes:
:class:`~azure.core.exceptions.ResourceNotFoundError` if the secret doesn't exist,
:class:`~azure.core.exceptions.HttpResponseError` for other errors

Example:
Example:
.. literalinclude:: ../tests/test_samples_secrets_async.py
:start-after: [START backup_secret]
:end-before: [END backup_secret]
Expand Down