CryptographyClient.SignData Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Keys.Cryptography

Assembly:: Azure.Security.KeyVault.Keys.dll

Package:: Azure.Security.KeyVault.Keys v4.7.0

Package:: Azure.Security.KeyVault.Keys v4.6.0-beta.2

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

SignData(SignatureAlgorithm, Byte[], CancellationToken)	Signs the specified data.
SignData(SignatureAlgorithm, Stream, CancellationToken)	Signs the specified data.

SignData(SignatureAlgorithm, Byte[], CancellationToken)

Source:: CryptographyClient.cs

Source:: CryptographyClient.cs

Signs the specified data.

public virtual Azure.Security.KeyVault.Keys.Cryptography.SignResult SignData (Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm algorithm, byte[] data, System.Threading.CancellationToken cancellationToken = default);

abstract member SignData : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.SignResult
override this.SignData : Azure.Security.KeyVault.Keys.Cryptography.SignatureAlgorithm * byte[] * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.Cryptography.SignResult

Public Overridable Function SignData (algorithm As SignatureAlgorithm, data As Byte(), Optional cancellationToken As CancellationToken = Nothing) As SignResult

Parameters

algorithm: SignatureAlgorithm

The SignatureAlgorithm to use.

data: Byte[]

The data to sign.

cancellationToken: CancellationToken

A CancellationToken to cancel the operation.

Returns

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.

Remarks

The hash algorithm used to compute the digest is derived from the specified algorithm:

Applies to

SignData(SignatureAlgorithm, Stream, CancellationToken)

Source:: CryptographyClient.cs

Source:: CryptographyClient.cs