KeyRecoverableDays Property

The number of days the key will be recoverable if it gets deleted.

Syntax

 azurekeys.getKeyRecoverableDays(index, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getKeyRecoverableDays([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setKeyRecoverableDays([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The number of days the key will be recoverable if it gets deleted.

This property reflects the number of days that the key will be recoverable for if it gets deleted.

Note that this property's value is based on the retention policy of the currently-selected Vault; it will not change after the key has actually been deleted.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer