Share via


CryptographyClient.SignAsync Method

Definition

Signs the specified digest.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SignResult> SignAsync (Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm algorithm, byte[] digest, System.Threading.CancellationToken cancellationToken = default);
abstract member SignAsync : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SignResult>
override this.SignAsync : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.Cryptography.SignResult>
Public Overridable Function SignAsync (algorithm As SignatureAlgorithm, digest As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of SignResult)

Parameters

algorithm
SignatureAlgorithm

The SignatureAlgorithm to use.

digest
Byte[]

The pre-hashed digest to sign. The hash algorithm used to compute the digest must be compatible with the specified algorithm.

cancellationToken
CancellationToken

A CancellationToken to cancel the operation.

Returns

The result of the sign operation. The returned SignResult contains the signature along with all other information needed to verify it. This information should be stored with the signature.

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