KeyVaultClient.SignWithHttpMessagesAsync メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.KeyVault
アセンブリ:
Microsoft.Azure.KeyVault.dll
パッケージ:
Microsoft.Azure.KeyVault v3.0.5
ソース:
KeyVaultClient.cs

指定したキーを使用してダイジェストから署名を作成します。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyOperationResult>> SignWithHttpMessagesAsync (string vaultBaseUrl, string keyName, string keyVersion, string algorithm, byte[] value, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SignWithHttpMessagesAsync : string * string * string * string * byte[] * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyOperationResult>>
override this.SignWithHttpMessagesAsync : string * string * string * string * byte[] * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyOperationResult>>
Public Function SignWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, keyVersion As String, algorithm As String, value As Byte(), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of KeyOperationResult))

パラメーター

vaultBaseUrl
String

コンテナー名 (例: https://myvault.vault.azure.net)。

keyName
String

キーの名前です。

keyVersion
String

キーのバージョン。

algorithm
String

署名/検証アルゴリズム識別子。 考えられるアルゴリズムの種類の詳細については、「JsonWebKeySignatureAlgorithm」を参照してください。 使用できる値は、'PS256'、'PS384'、'PS512'、'RS256'、'RS384'、'RS512'、'RSNULL'、'ES256'、'ES384'、'ES512'、'ECDSA256' です。

value
Byte[]
customHeaders
Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<KeyOperationResult>>

実装

SignWithHttpMessagesAsync(String, String, String, String, Byte[], Dictionary<String,List<String>>, CancellationToken)

例外

KeyVaultErrorException

操作が無効な状態コードを返したときにスローされます

SerializationException

応答を逆シリアル化できない場合にスローされます

ValidationException

必須パラメーターが null の場合にスローされます

ArgumentNullException

必須パラメーターが null の場合にスローされます

注釈

SIGN 操作は、Azure Key Vaultに格納されている非対称キーと対称キーに適用されます。この操作ではキーの秘密部分が使用されるためです。 この操作には、キー/署名アクセス許可が必要です。

適用対象