KeyVaultClientExtensions.VerifyAsync 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
| VerifyAsync(IKeyVaultClient, String, String, Byte[], Byte[], CancellationToken) |
Verifies a signature using the specified key |
| VerifyAsync(IKeyVaultClient, String, String, String, String, Byte[], Byte[], CancellationToken) |
Verifies a signature using a specified key. |
VerifyAsync(IKeyVaultClient, String, String, Byte[], Byte[], CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
Verifies a signature using the specified key
public static System.Threading.Tasks.Task<bool> VerifyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string keyIdentifier, string algorithm, byte[] digest, byte[] signature, System.Threading.CancellationToken cancellationToken = default);static member VerifyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * byte[] * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool><Extension()>
Public Function VerifyAsync (operations As IKeyVaultClient, keyIdentifier As String, algorithm As String, digest As Byte(), signature As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)Parameters
- operations
- IKeyVaultClient
- keyIdentifier
- String
The global key identifier of the key used for signing
- algorithm
- String
The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.
- digest
- Byte[]
The digest used for signing
- signature
- Byte[]
The signature to be verified
- cancellationToken
- CancellationToken
Optional cancellation token
Returns
true if the signature is verified, false otherwise.
Applies to
VerifyAsync(IKeyVaultClient, String, String, String, String, Byte[], Byte[], CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
Verifies a signature using a specified key.
public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyVerifyResult> VerifyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, string keyVersion, string algorithm, byte[] digest, byte[] signature, System.Threading.CancellationToken cancellationToken = default);static member VerifyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * string * string * byte[] * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyVerifyResult><Extension()>
Public Function VerifyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, keyVersion As String, algorithm As String, digest As Byte(), signature As Byte(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyVerifyResult)Parameters
- operations
- IKeyVaultClient
The operations group for this extension method.
- vaultBaseUrl
- String
The vault name, for example https://myvault.vault.azure.net.
- keyName
- String
The name of the key.
- keyVersion
- String
The version of the key.
- algorithm
- String
The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm. Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384', 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ECDSA256'
- digest
- Byte[]
The digest used for signing.
- signature
- Byte[]
The signature to be verified.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Remarks
The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.
