Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeyProperties

Package version

An interface representing the Properties of KeyVaultKey

Hierarchy

  • KeyProperties

Index

Properties

Optional createdOn

createdOn: Date

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

Optional enabled

enabled: undefined | false | true

Determines whether the object is enabled.

Optional expiresOn

expiresOn: Date

Expiry date in UTC.

Optional exportable

exportable: undefined | false | true

Indicates whether the private key can be exported.

Optional id

id: undefined | string

Key identifier.

Optional managed

managed: undefined | false | true

True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. NOTE: This property will not be serialized. It can only be populated by the server.

name

name: string

The name of the key.

Optional notBefore

notBefore: Date

Not before date in UTC.

Optional recoverableDays

recoverableDays: undefined | number

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.

Optional recoveryLevel

recoveryLevel: DeletionRecoveryLevel

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.

Optional releasePolicy

releasePolicy: KeyReleasePolicy

A KeyReleasePolicy object specifying the rules under which the key can be exported.

Optional tags

tags: undefined | {}

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

Optional updatedOn

updatedOn: Date

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

vaultUrl

vaultUrl: string

The vault URI.

Optional version

version: undefined | string

The version of the key. May be undefined.

Generated using TypeDoc