CryptographyClient.UnwrapKey Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Decrypts the specified encrypted key.
public virtual Azure.Security.KeyVault.Keys.Cryptography.UnwrapResult UnwrapKey (Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm algorithm, byte[] encryptedKey, System.Threading.CancellationToken cancellationToken = default);abstract member UnwrapKey : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.UnwrapResult
override this.UnwrapKey : Azure.Security.KeyVault.Keys.Cryptography.KeyWrapAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.UnwrapResultPublic Overridable Function UnwrapKey (algorithm As KeyWrapAlgorithm, encryptedKey As Byte(), Optional cancellationToken As CancellationToken = Nothing) As UnwrapResultParameters
- algorithm
- KeyWrapAlgorithm
The KeyWrapAlgorithm to use.
- encryptedKey
- Byte[]
The encrypted key.
- cancellationToken
- CancellationToken
A CancellationToken to cancel the operation.
Returns
The result of the unwrap operation. The returned UnwrapResult contains the key along with information regarding the algorithm and key used to unwrap it.
Exceptions
The specified algorithm does not match the key corresponding to the key identifier.
The local cryptographic provider threw an exception.
The key is invalid for the current operation.
The operation is not supported with the specified key.
The server returned an error. See Message for details returned from the server.
