BackupSecret Method

Backs up a secret.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int BackupSecret(const char* lpszSecretName);

Unicode (Windows)
INT BackupSecret(LPCWSTR lpszSecretName);

- (void)backupSecret:(NSString*)secretName;

#define MID_AZURESECRETS_BACKUPSECRET 4

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

Remarks

This method backs up the secret specified by SecretName, returning it in a protected form via the output stream specified via the SetOutputStream method, the specified LocalFile, or the SecretData property.

Note that the protected secret cannot be used outside of Azure Key Vault, it must be restored to another vault using the RestoreSecret method in order to be used.

Error Handling (C++)

This method returns a 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. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)