Package version:

Interface KeyProperties

An interface representing the Properties of KeyVaultKey

Hierarchy

  • KeyProperties

Properties

createdOn?: any

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

enabled?: boolean

Determines whether the object is enabled.

expiresOn?: any

Expiry date in UTC.

exportable?: boolean

Indicates whether the private key can be exported.

id?: string

Key identifier.

managed?: boolean

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: string

The name of the key.

notBefore?: any

Not before date in UTC.

recoverableDays?: 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.

recoveryLevel?: string

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.

releasePolicy?: KeyReleasePolicy

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

tags?: {
    [propertyName: string]: string;
}

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

Type declaration

  • [propertyName: string]: string
updatedOn?: any

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

vaultUrl: string

The vault URI.

version?: string

The version of the key. May be undefined.

Generated using TypeDoc