KeyProperties interface

An interface representing the Properties of <xref:KeyVaultKey>

Properties

createdOn

Creation time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

enabled

Determines whether the object is enabled.

expiresOn

Expiry date in UTC.

id

Key identifier.

name

The name of the key.

notBefore

Not before date in UTC.

recoverableDays

The retention dates of the softDelete data. The value should be >=7 and <=90 when softDelete enabled. NOTE: This property will not be serialized. It can only be populated by the server.

recoveryLevel

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server.

tags

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

updatedOn

Last updated time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

vaultUrl

The vault URI.

version

The version of the key. May be undefined.

Property Details

createdOn

Creation time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn?: Date

Property Value

Date

enabled

Determines whether the object is enabled.

enabled?: boolean

Property Value

boolean

expiresOn

Expiry date in UTC.

expiresOn?: Date

Property Value

Date

id

Key identifier.

id?: string

Property Value

string

name

The name of the key.

name: string

Property Value

string

notBefore

Not before date in UTC.

notBefore?: Date

Property Value

Date

recoverableDays

The retention dates of the softDelete data. The value should be >=7 and <=90 when softDelete enabled. NOTE: This property will not be serialized. It can only be populated by the server.

recoverableDays?: number

Property Value

number

recoveryLevel

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval. Possible values include: 'Purgeable', 'Recoverable+Purgeable', 'Recoverable', 'Recoverable+ProtectedSubscription' NOTE: This property will not be serialized. It can only be populated by the server.

recoveryLevel?: DeletionRecoveryLevel

Property Value

tags

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

tags?: [key: string]: string

Property Value

[key: string]: string

updatedOn

Last updated time in UTC. NOTE: This property will not be serialized. It can only be populated by the server.

updatedOn?: Date

Property Value

Date

vaultUrl

The vault URI.

vaultUrl: string

Property Value

string

version

The version of the key. May be undefined.

version?: string

Property Value

string