on_key_list Event
Fires once for each key when listing keys.
Syntax
class AzureKeysKeyListEventParams(object): @property def name() -> str: ... @property def version_id() -> str: ... @property def key_type() -> str: ... @property def key_ops() -> str: ... @property def enabled() -> bool: ... @property def creation_date() -> int: ... @property def update_date() -> int: ... @property def deletion_date() -> int: ... @property def purge_date() -> int: ... @property def public_key() -> str: ... # In class AzureKeys: @property def on_key_list() -> Callable[[AzureKeysKeyListEventParams], None]: ... @on_key_list.setter def on_key_list(event_hook: Callable[[AzureKeysKeyListEventParams], None]) -> None: ...
Remarks
This event fires once for each key (or key version) returned when list_keys, list_versions, or get_key_info is called. However, note that the KeyOps, KeyType, PublicKey, and (for list_keys) VersionId parameters are not populated when one of the listing methods is called unless the include_key_details property is enabled; refer to its documentation for more information.
Name reflects the name of the key.
VersionId reflects the Id of the key version.
KeyType reflects the key's type. Each key type has two variants, a software-based one and an HSM-based one. Possible values are shown in the first two columns of the following table:
| Software-based | HSM-based | Description |
| EC_P256 | EC_HSM_P256 | The NIST P-256 curve (SECP256R1). |
| EC_P256K | EC_HSM_P256K | The SECP256K1 curve. |
| EC_P384 | EC_HSM_P384 | The NIST P-384 curve (SECP384R1). |
| EC_P521 | EC_HSM_P521 | The NIST P-521 curve (SECP521R1). |
| RSA_2048 | RSA_HSM_2048 | 2048-bit RSA key. |
| RSA_3072 | RSA_HSM_3072 | 3072-bit RSA key. |
| RSA_4096 | RSA_HSM_4096 | 4096-bit RSA key. |
KeyOps reflects a comma-separated list of operations that the key may be used for. Possible values are:
- encrypt
- decrypt
- sign
- verify
- wrapKey
- unwrapKey
Enabled reflects whether the key is currently enabled.
CreationDate reflects the key's creation date, in seconds since the Unix epoch.
UpdateDate reflects the key's update date, in seconds since the Unix epoch.
DeletionDate reflects the key's deletion date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PurgeDate reflects the key's purge (i.e., permanent deletion) date, in seconds since the Unix epoch, or -1 if the key has not been deleted.
PublicKey reflects the key's public key, in PEM format.