restore_secret Method

Restores a previously backed-up secret to the vault.

Syntax

def restore_secret() -> str: ...

Remarks

This method restores a secret previously backed up using backup_secret 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 local_file or the secret_data 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.