Cloud Keys 2020 Node.js Edition

Questions / Feedback?

RestoreSecret Method

Restores a previously backed-up secret to the vault.




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 this 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.

'err' has 2 properties which hold detailed information:



This method restores a secret previously backed up using BackupSecret to the currently-selected Vault. The secret is restored in its entirety, with all of its versions intact. However, note that the restore will fail if the secret's name is already in use. The name of the restored secret is returned.

The protected secret data to restore is taken from the the specified LocalFile or the SecretData property.

Note: There are certain restrictions on which vaults a secret can be restored to. In particular, a secret must be restored to a vault owned by the same Azure subscription that owned its original vault, and must be restored to a vault in the same geolocation as its original vault. Refer to the Azure Key Vault documentation for more information.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]