Skip to content

Commit

Permalink
Rename Key and Secret to KeyVault* (#7876)
Browse files Browse the repository at this point in the history
  • Loading branch information
@chlowell
chlowell authored Oct 16, 2019
1 parent 0baf202 commit a02cbde
Show file tree
Hide file tree
Showing 11 changed files with 93 additions and 92 deletions.
4 changes: 2 additions & 2 deletions sdk/keyvault/azure-keyvault-keys/HISTORY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ detail the new keyword arguments):
- `CryptographyClient` operations return class instances instead of tuples. The
new classes have the same attributes as the tuples.
- Renamed `list_keys` to `list_properties_of_keys`
- Renamed `restore_key` to `restore_key_backup`
- `Key` properties `created`, `expires`, and `updated` renamed to `created_on`,
- Renamed `Key` to `KeyVaultKey`
- `KeyVaultKey` properties `created`, `expires`, and `updated` renamed to `created_on`,
`expires_on`, and `updated_on`


Expand Down
49 changes: 25 additions & 24 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/aio/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from datetime import datetime
from typing import TYPE_CHECKING

from azure.core.tracing.decorator import distributed_trace
from azure.core.tracing.decorator_async import distributed_trace_async
from azure.keyvault.keys.models import DeletedKey, JsonWebKey, Key, KeyProperties
from azure.keyvault.keys.models import DeletedKey, JsonWebKey, KeyVaultKey, KeyProperties
from azure.keyvault.keys._shared import AsyncKeyVaultClientBase

from .._shared.exceptions import error_map as _error_map


if TYPE_CHECKING:
# pylint:disable=ungrouped-imports
from datetime import datetime
from typing import AsyncIterable, Optional, List, Union
from ..enums import KeyType

Expand Down Expand Up @@ -42,15 +43,15 @@ class KeyClient(AsyncKeyVaultClientBase):
# pylint:disable=protected-access

@distributed_trace_async
async def create_key(self, name: str, key_type: "Union[str, KeyType]", **kwargs: "Any") -> Key:
async def create_key(self, name: str, key_type: "Union[str, KeyType]", **kwargs: "Any") -> KeyVaultKey:
"""Create a key. If ``name`` is already in use, create a new version of the key. Requires the keys/create
permission.
:param str name: The name of the new key. Key Vault will generate the key's version.
:param key_type: The type of key to create
:type key_type: str or ~azure.keyvault.keys.enums.KeyType
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand Down Expand Up @@ -91,16 +92,16 @@ async def create_key(self, name: str, key_type: "Union[str, KeyType]", **kwargs:
key_ops=kwargs.pop("key_operations", None),
**kwargs,
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace_async
async def create_rsa_key(self, name: str, **kwargs: "Any") -> Key:
async def create_rsa_key(self, name: str, **kwargs: "Any") -> KeyVaultKey:
"""Create a new RSA key. If ``name`` is already in use, create a new version of the key. Requires the
keys/create permission.
:param str name: The name for the new key
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand All @@ -125,13 +126,13 @@ async def create_rsa_key(self, name: str, **kwargs: "Any") -> Key:
return await self.create_key(name, key_type="RSA-HSM" if hsm else "RSA", **kwargs)

@distributed_trace_async
async def create_ec_key(self, name: str, **kwargs: "Any") -> Key:
async def create_ec_key(self, name: str, **kwargs: "Any") -> KeyVaultKey:
"""Create a new elliptic curve key. If ``name`` is already in use, create a new version of the key. Requires
the keys/create permission.
:param str name: The name for the new key. Key Vault will generate the key's version.
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand Down Expand Up @@ -179,13 +180,13 @@ async def delete_key(self, name: str, **kwargs: "Any") -> DeletedKey:
return DeletedKey._from_deleted_key_bundle(bundle)

@distributed_trace_async
async def get_key(self, name: str, version: "Optional[str]" = None, **kwargs: "Any") -> Key:
async def get_key(self, name: str, version: "Optional[str]" = None, **kwargs: "Any") -> KeyVaultKey:
"""Get a key's attributes and, if it's an asymmetric key, its public material. Requires the keys/get permission.
:param str name: The name of the key to get.
:param str version: (optional) A specific version of the key to get. If not specified, gets the latest version
of the key.
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand All @@ -202,7 +203,7 @@ async def get_key(self, name: str, version: "Optional[str]" = None, **kwargs: "A
version = ""

bundle = await self._client.get_key(self.vault_endpoint, name, version, error_map=_error_map, **kwargs)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace_async
async def get_deleted_key(self, name: str, **kwargs: "Any") -> DeletedKey:
Expand Down Expand Up @@ -321,7 +322,7 @@ async def purge_deleted_key(self, name: str, **kwargs: "Any") -> None:
await self._client.purge_deleted_key(self.vault_endpoint, name, **kwargs)

@distributed_trace_async
async def recover_deleted_key(self, name: str, **kwargs: "Any") -> Key:
async def recover_deleted_key(self, name: str, **kwargs: "Any") -> KeyVaultKey:
"""Recover a deleted key to its latest version. This is only possible in vaults with soft-delete enabled. If a
vault does not have soft-delete enabled, :func:`delete_key` is permanent, and this method will return an error.
Attempting to recover an non-deleted key will also return an error.
Expand All @@ -330,7 +331,7 @@ async def recover_deleted_key(self, name: str, **kwargs: "Any") -> Key:
:param str name: The name of the deleted key
:returns: The recovered key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Example:
Expand All @@ -342,17 +343,17 @@ async def recover_deleted_key(self, name: str, **kwargs: "Any") -> Key:
:dedent: 8
"""
bundle = await self._client.recover_deleted_key(self.vault_endpoint, name, **kwargs)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace_async
async def update_key_properties(self, name: str, version: "Optional[str]" = None, **kwargs: "Any") -> Key:
async def update_key_properties(self, name: str, version: "Optional[str]" = None, **kwargs: "Any") -> KeyVaultKey:
"""Change attributes of a key. Cannot change a key's cryptographic material. Requires the keys/update
permission.
:param str name: The name of key to update
:param str version: (optional) The version of the key to update. If unspecified, the latest version is updated.
:returns: The updated key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand Down Expand Up @@ -388,7 +389,7 @@ async def update_key_properties(self, name: str, version: "Optional[str]" = None
error_map=_error_map,
**kwargs,
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace_async
async def backup_key(self, name: str, **kwargs: "Any") -> bytes:
Expand Down Expand Up @@ -417,7 +418,7 @@ async def backup_key(self, name: str, **kwargs: "Any") -> bytes:
return backup_result.value

@distributed_trace_async
async def restore_key_backup(self, backup: bytes, **kwargs: "Any") -> Key:
async def restore_key_backup(self, backup: bytes, **kwargs: "Any") -> KeyVaultKey:
"""Restore a key backup to the vault. This imports all versions of the key, with its name, attributes, and
access control policies. Requires the keys/restore permission.
Expand All @@ -426,7 +427,7 @@ async def restore_key_backup(self, backup: bytes, **kwargs: "Any") -> Key:
:param bytes backup: The raw bytes of the key backup
:returns: The restored key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand All @@ -440,18 +441,18 @@ async def restore_key_backup(self, backup: bytes, **kwargs: "Any") -> Key:
:dedent: 8
"""
bundle = await self._client.restore_key(self.vault_endpoint, backup, error_map=_error_map, **kwargs)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace_async
async def import_key(self, name: str, key: JsonWebKey, **kwargs: "Any") -> Key:
async def import_key(self, name: str, key: JsonWebKey, **kwargs: "Any") -> KeyVaultKey:
"""Import an externally created key. If ``name`` is already in use, import the key as a new version. Requires
the keys/import permission.
:param str name: Name for the imported key
:param key: The JSON web key to import
:type key: ~azure.keyvault.keys.models.JsonWebKey
:returns: The imported key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand All @@ -476,4 +477,4 @@ async def import_key(self, name: str, key: JsonWebKey, **kwargs: "Any") -> Key:
hsm=kwargs.pop("hardware_protected", None),
**kwargs
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)
46 changes: 23 additions & 23 deletions sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

from ._shared import KeyVaultClientBase
from ._shared.exceptions import error_map as _error_map
from .models import Key, KeyProperties, DeletedKey
from .models import KeyVaultKey, KeyProperties, DeletedKey

try:
from typing import TYPE_CHECKING
Expand Down Expand Up @@ -46,15 +46,15 @@ class KeyClient(KeyVaultClientBase):

@distributed_trace
def create_key(self, name, key_type, **kwargs):
# type: (str, Union[str, azure.keyvault.keys.enums.KeyType], **Any) -> Key
# type: (str, Union[str, azure.keyvault.keys.enums.KeyType], **Any) -> KeyVaultKey
"""Create a key. If ``name`` is already in use, create a new version of the key. Requires the keys/create
permission.
:param str name: The name of the new key. Key Vault will generate the key's version.
:param key_type: The type of key to create
:type key_type: str or ~azure.keyvault.keys.enums.KeyType
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand Down Expand Up @@ -94,17 +94,17 @@ def create_key(self, name, key_type, **kwargs):
key_ops=kwargs.pop("key_operations", None),
**kwargs
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace
def create_rsa_key(self, name, **kwargs):
# type: (str, **Any) -> Key
# type: (str, **Any) -> KeyVaultKey
"""Create a new RSA key. If ``name`` is already in use, create a new version of the key. Requires the
keys/create permission.
:param str name: The name for the new key
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand All @@ -130,13 +130,13 @@ def create_rsa_key(self, name, **kwargs):

@distributed_trace
def create_ec_key(self, name, **kwargs):
# type: (str, **Any) -> Key
# type: (str, **Any) -> KeyVaultKey
"""Create a new elliptic curve key. If ``name`` is already in use, create a new version of the key. Requires
the keys/create permission.
:param str name: The name for the new key. Key Vault will generate the key's version.
:returns: The created key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand Down Expand Up @@ -186,13 +186,13 @@ def delete_key(self, name, **kwargs):

@distributed_trace
def get_key(self, name, version=None, **kwargs):
# type: (str, Optional[str], **Any) -> Key
# type: (str, Optional[str], **Any) -> KeyVaultKey
"""Get a key's attributes and, if it's an asymmetric key, its public material. Requires the keys/get permission.
:param str name: The name of the key to get.
:param str version: (optional) A specific version of the key to get. If not specified, gets the latest version
of the key.
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand All @@ -208,7 +208,7 @@ def get_key(self, name, version=None, **kwargs):
bundle = self._client.get_key(
self.vault_endpoint, name, key_version=version or "", error_map=_error_map, **kwargs
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace
def get_deleted_key(self, name, **kwargs):
Expand Down Expand Up @@ -334,7 +334,7 @@ def purge_deleted_key(self, name, **kwargs):

@distributed_trace
def recover_deleted_key(self, name, **kwargs):
# type: (str, **Any) -> Key
# type: (str, **Any) -> KeyVaultKey
"""Recover a deleted key to its latest version. This is only possible in vaults with soft-delete enabled. If a
vault does not have soft-delete enabled, :func:`delete_key` is permanent, and this method will return an error.
Attempting to recover an non-deleted key will also return an error.
Expand All @@ -343,7 +343,7 @@ def recover_deleted_key(self, name, **kwargs):
:param str name: The name of the deleted key
:returns: The recovered key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Example:
Expand All @@ -355,18 +355,18 @@ def recover_deleted_key(self, name, **kwargs):
:dedent: 8
"""
bundle = self._client.recover_deleted_key(vault_base_url=self.vault_endpoint, key_name=name, **kwargs)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace
def update_key_properties(self, name, version=None, **kwargs):
# type: (str, Optional[str], **Any) -> Key
# type: (str, Optional[str], **Any) -> KeyVaultKey
"""Change attributes of a key. Cannot change a key's cryptographic material. Requires the keys/update
permission.
:param str name: The name of key to update
:param str version: (optional) The version of the key to update. If unspecified, the latest version is updated.
:returns: The updated key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceNotFoundError` if the key doesn't exist,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand Down Expand Up @@ -402,7 +402,7 @@ def update_key_properties(self, name, version=None, **kwargs):
error_map=_error_map,
**kwargs
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace
def backup_key(self, name, **kwargs):
Expand Down Expand Up @@ -433,7 +433,7 @@ def backup_key(self, name, **kwargs):

@distributed_trace
def restore_key_backup(self, backup, **kwargs):
# type: (bytes, **Any) -> Key
# type: (bytes, **Any) -> KeyVaultKey
"""Restore a key backup to the vault. This imports all versions of the key, with its name, attributes, and
access control policies. Requires the keys/restore permission.
Expand All @@ -442,7 +442,7 @@ def restore_key_backup(self, backup, **kwargs):
:param bytes backup: The raw bytes of the key backup
:returns: The restored key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises:
:class:`~azure.core.exceptions.ResourceExistsError` if the backed up key's name is already in use,
:class:`~azure.core.exceptions.HttpResponseError` for other errors
Expand All @@ -456,19 +456,19 @@ def restore_key_backup(self, backup, **kwargs):
:dedent: 8
"""
bundle = self._client.restore_key(self.vault_endpoint, backup, error_map=_error_map, **kwargs)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)

@distributed_trace
def import_key(self, name, key, **kwargs):
# type: (str, JsonWebKey, **Any) -> Key
# type: (str, JsonWebKey, **Any) -> KeyVaultKey
"""Import an externally created key. If ``name`` is already in use, import the key as a new version. Requires
the keys/import permission.
:param str name: Name for the imported key
:param key: The JSON web key to import
:type key: ~azure.keyvault.keys.models.JsonWebKey
:returns: The imported key
:rtype: ~azure.keyvault.keys.models.Key
:rtype: ~azure.keyvault.keys.models.KeyVaultKey
:raises: :class:`~azure.core.exceptions.HttpResponseError`
Keyword arguments
Expand All @@ -493,4 +493,4 @@ def import_key(self, name, key, **kwargs):
hsm=kwargs.pop("hardware_protected", None),
**kwargs
)
return Key._from_key_bundle(bundle)
return KeyVaultKey._from_key_bundle(bundle)
Loading

0 comments on commit a02cbde

Please sign in to comment.