SecretProperties Class

A secret's ID and attributes.

Inheritance

builtins.object

SecretProperties

Constructor

SecretProperties(*args: Any, **kwargs: Any)

Attributes

content_type

An arbitrary string indicating the type of the secret.

Returns

Type	Description
str, None	The content type of the secret.

created_on

When the secret was created, in UTC.

Returns

Type	Description
datetime, None	When the secret was created, in UTC.

enabled

Whether the secret is enabled for use.

Returns

Type	Description
bool, None	True if the secret is enabled for use; False otherwise.

expires_on

When the secret expires, in UTC.

Returns

Type	Description
datetime, None	When the secret expires, in UTC.

id

The secret's ID.

Returns

Type	Description
str, None	The secret's ID.

key_id

If this secret backs a certificate, this property is the identifier of the corresponding key.

Returns

Type	Description
str, None	The ID of the key backing the certificate that's backed by this secret. If the secret isn't backing a certificate, this is None.

managed

Whether the secret's lifetime is managed by Key Vault. If the secret backs a certificate, this will be true.

Returns

Type	Description
bool, None	True if the secret's lifetime is managed by Key Vault; False otherwise.

name

The secret's name.

Returns

Type	Description
str, None	The secret's name.

not_before

The time before which the secret cannot be used, in UTC.

Returns

Type	Description
datetime, None	The time before which the secret cannot be used, in UTC.

recoverable_days

The number of days the key is retained before being deleted from a soft-delete enabled Key Vault.

Returns

Type	Description
int, None	The number of days the key is retained before being deleted from a soft-delete enabled Key Vault.

recovery_level

The vault's deletion recovery level for secrets.

Returns

Type	Description
str, None	The vault's deletion recovery level for secrets.

tags

Application specific metadata in the form of key-value pairs.

Returns

Type	Description
dict, None	A dictionary of tags attached to this secret.

updated_on

When the secret was last updated, in UTC.

Returns

Type	Description
datetime, None	When the secret was last updated, in UTC.

vault_url

URL of the vault containing the secret.

Returns

Type	Description
str, None	URL of the vault containing the secret.

version

The secret's version.

Returns

Type	Description
str, None	The secret's version.