Add .from_jwk example

Azure · Mar 5, 2021 · 218a312 · 218a312
1 parent 0d2519f
commit 218a312
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/_client.py b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/_client.py
@@ -142,6 +142,13 @@ def from_jwk(cls, jwk):
         :param jwk: the key's cryptographic material, as a JsonWebKey or dictionary.
         :type jwk: JsonWebKey or dict
         :rtype: CryptographyClient
+
+        .. literalinclude:: ../tests/test_examples_crypto.py
+            :start-after: [START from_jwk]
+            :end-before: [END from_jwk]
+            :caption: Create a CryptographyClient from a JsonWebKey
+            :language: python
+            :dedent: 8
         """
         if isinstance(jwk, JsonWebKey):
             key = vars(jwk)

diff --git a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/aio/_client.py b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/crypto/aio/_client.py
@@ -95,6 +95,13 @@ def from_jwk(cls, jwk: "Union[JsonWebKey, dict]") -> "CryptographyClient":
         :param jwk: the key's cryptographic material, as a JsonWebKey or dictionary.
         :type jwk: JsonWebKey or dict
         :rtype: CryptographyClient
+
+        .. literalinclude:: ../tests/test_examples_crypto.py
+            :start-after: [START from_jwk]
+            :end-before: [END from_jwk]
+            :caption: Create a CryptographyClient from a JsonWebKey
+            :language: python
+            :dedent: 8
         """
         if isinstance(jwk, JsonWebKey):
             key = vars(jwk)

diff --git a/sdk/keyvault/azure-keyvault-keys/tests/test_examples_crypto.py b/sdk/keyvault/azure-keyvault-keys/tests/test_examples_crypto.py
@@ -4,7 +4,7 @@
 # ------------------------------------
 import functools
 
-from azure.keyvault.keys import KeyClient
+from azure.keyvault.keys import JsonWebKey, KeyClient
 from azure.keyvault.keys.crypto import CryptographyClient
 from azure.keyvault.keys._shared import HttpChallengeCache
 from devtools_testutils import PowerShellPreparer
@@ -18,6 +18,18 @@
 )
 
 
+def test_create_client_from_jwk():
+    # [START from_jwk]
+    # create a CryptographyClient using a JsonWebKey instance
+    key = JsonWebKey(kty="RSA")
+    crypto_client = CryptographyClient.from_jwk(jwk=key)
+
+    # or a dictionary with JsonWebKey properties
+    key_dict = {"kty":"RSA"}
+    crypto_client = CryptographyClient.from_jwk(jwk=key_dict)
+    # [END from_jwk]
+
+
 class TestCryptoExamples(KeyVaultTestCase):
     def __init__(self, *args, **kwargs):
         kwargs["match_body"] = False