RestoreSecret Method

Restores a previously backed-up secret to the vault.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* RestoreSecret();

Unicode (Windows)
LPWSTR RestoreSecret();

- (NSString*)restoreSecret;

#define MID_AZURESECRETS_RESTORESECRET 15

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AzureSecrets_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

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 input stream supplied via the SetInputStream method, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.