CryptographyClient.SignAsync Method

Definition

Namespace:

Azure.Security.KeyVault.Keys.Cryptography

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.6.0

Source:

CryptographyClient.cs

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

Task<SignResult>

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

ArgumentException

The specified algorithm does not match the key corresponding to the key identifier.

CryptographicException

The local cryptographic provider threw an exception.

InvalidOperationException

The key is invalid for the current operation.

NotSupportedException

The operation is not supported with the specified key.

RequestFailedException

The server returned an error. See Message for details returned from the server.