DeletedSecret Class

A deleted secret's properties and information about its deletion.

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

Inheritance
builtins.object
DeletedSecret

Constructor

DeletedSecret(properties: SecretProperties, deleted_date: datetime | None = None, recovery_id: str | None = None, scheduled_purge_date: datetime | None = None)

Parameters

Name Description
properties
Required

The deleted secret's properties.

deleted_date

When the secret was deleted, in UTC.

Default value: None
recovery_id
str or None

An identifier used to recover the deleted secret.

Default value: None
scheduled_purge_date

When the secret is scheduled to be purged by Key Vault, in UTC.

Default value: None

Attributes

deleted_date

When the secret was deleted, in UTC.

Returns

Type Description

When the secret was deleted, in UTC.

id

The secret's ID.

Returns

Type Description
str,

The secret's ID.

name

The secret's name.

Returns

Type Description
str,

The secret's name.

properties

The properties of the deleted secret.

Returns

Type Description

The properties of the deleted secret.

recovery_id

An identifier used to recover the deleted secret.

Returns

Type Description
str,

An identifier used to recover the deleted secret.

scheduled_purge_date

When the secret is scheduled to be purged by Key Vault, in UTC.

Returns

Type Description

When the secret is scheduled to be purged by Key Vault, in UTC.