DeletedKey Class

A deleted key's properties, cryptographic material and its deletion information.

If soft-delete is enabled, returns information about its recovery as well.

Inheritance

azure.keyvault.keys._models.KeyVaultKey

DeletedKey

Constructor

DeletedKey(properties: KeyProperties, deleted_date: datetime | None = None, recovery_id: str | None = None, scheduled_purge_date: datetime | None = None, **kwargs: Any)

Parameters

Name	Description
properties Required	KeyProperties Properties of the deleted key.
deleted_date	datetime or None When the key was deleted, in UTC. Default value: None
recovery_id	str or None An identifier used to recover the deleted key. Returns None if soft-delete is disabled. Default value: None
scheduled_purge_date	datetime or None When the key is scheduled to be purged, in UTC. Returns None if soft-delete is disabled. Default value: None

Attributes

deleted_date

When the key was deleted, in UTC.

Returns

Type	Description
datetime, None	When the key was deleted, in UTC.

id

The key ID.

Returns

Type	Description
str	The key ID.

key

The JSON Web Key (JWK) for the key.

Returns

Type	Description
JsonWebKey	The JSON Web Key (JWK) for the key.

key_operations

Permitted operations. See KeyOperation for possible values.

Returns

Type	Description
List[KeyOperation, str]	Permitted operations. See KeyOperation for possible values.

key_type

The key's type. See KeyType for possible values.

Returns

Type	Description
KeyType, str	The key's type. See KeyType for possible values.

name

The key name.

Returns

Type	Description
str	The key name.

properties

The key properties.

Returns

Type	Description
KeyProperties	The key properties.

recovery_id

An identifier used to recover the deleted key. Returns None if soft-delete is disabled.

Returns

Type	Description
str, None	An identifier used to recover the deleted key. Returns None if soft-delete is disabled.

scheduled_purge_date

When the key is scheduled to be purged, in UTC. Returns None if soft-delete is disabled.

Returns

Type	Description
datetime, None	When the key is scheduled to be purged, in UTC. Returns None if soft-delete is disabled.