SecretRecoveryLevel Property

The secret's ability to be recovered and/or purged if it gets deleted.

Syntax

 azuresecrets.getSecretRecoveryLevel(index, [callback])

Default Value

""

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 getSecretRecoveryLevel([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 setSecretRecoveryLevel([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 secret's ability to be recovered and/or purged if it gets deleted.

This property reflects the secret's ability to be recovered and/or purged (i.e., permanently deleted) if it gets deleted. Possible values are as follows; please refer to this part of the Azure Key Vault documentation for more information about each one:

• CustomizedRecoverable
• CustomizedRecoverable+ProtectedSubscription
• CustomizedRecoverable+Purgeable
• Purgeable
• Recoverable
• Recoverable+ProtectedSubscription
• Recoverable+Purgeable

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

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

Data Type

String