CryptographyClient.Decrypt 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.
Overloads
| Decrypt(DecryptParameters, CancellationToken) |
Decrypts the specified ciphertext. |
| Decrypt(EncryptionAlgorithm, Byte[], CancellationToken) |
Decrypts ciphertext. |
Decrypt(DecryptParameters, CancellationToken)
- Source:
- CryptographyClient.cs
- Source:
- CryptographyClient.cs
Decrypts the specified ciphertext.
public virtual Azure.Security.KeyVault.Keys.Cryptography.DecryptResult Decrypt (Azure.Security.KeyVault.Keys.Cryptography.DecryptParameters decryptParameters, System.Threading.CancellationToken cancellationToken = default);abstract member Decrypt : Azure.Security.KeyVault.Keys.Cryptography.DecryptParameters * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.DecryptResult
override this.Decrypt : Azure.Security.KeyVault.Keys.Cryptography.DecryptParameters * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.DecryptResultPublic Overridable Function Decrypt (decryptParameters As DecryptParameters, Optional cancellationToken As CancellationToken = Nothing) As DecryptResultParameters
- decryptParameters
- DecryptParameters
A DecryptParameters containing the data to decrypt and other parameters for algorithm-dependent decryption.
- cancellationToken
- CancellationToken
A CancellationToken to cancel the operation.
Returns
The result of the decrypt operation. The returned DecryptResult contains the encrypted data along with information regarding the algorithm and key used to decrypt it.
Exceptions
The specified algorithm does not match the key corresponding to the key identifier.
decryptParameters is null.
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.
Applies to
Decrypt(EncryptionAlgorithm, Byte[], CancellationToken)
- Source:
- CryptographyClient.cs
- Source:
- CryptographyClient.cs
Decrypts ciphertext.
public virtual Azure.Security.KeyVault.Keys.Cryptography.DecryptResult Decrypt (Azure.Security.KeyVault.Keys.Cryptography.EncryptionAlgorithm algorithm, byte[] ciphertext, System.Threading.CancellationToken cancellationToken = default);abstract member Decrypt : Azure.Security.KeyVault.Keys.Cryptography.EncryptionAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.DecryptResult
override this.Decrypt : Azure.Security.KeyVault.Keys.Cryptography.EncryptionAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.DecryptResultPublic Overridable Function Decrypt (algorithm As EncryptionAlgorithm, ciphertext As Byte(), Optional cancellationToken As CancellationToken = Nothing) As DecryptResultParameters
- algorithm
- EncryptionAlgorithm
The EncryptionAlgorithm to use.
- ciphertext
- Byte[]
The encrypted data to decrypt.
- cancellationToken
- CancellationToken
A CancellationToken to cancel the operation.
Returns
The result of the decrypt operation. The returned DecryptResult contains the encrypted data along with information regarding the algorithm and key used to decrypt 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.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for