KeyVaultClient.WrapKeyWithHttpMessagesAsync メソッド

定義

名前空間:

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>> WrapKeyWithHttpMessagesAsync (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 WrapKeyWithHttpMessagesAsync : 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.WrapKeyWithHttpMessagesAsync : 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 WrapKeyWithHttpMessagesAsync (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

アルゴリズム識別子。 使用できる値は、'RSA-OAEP'、'RSA-OAEP-256'、'RSA1_5' です。

value

Byte[]

customHeaders

Dictionary<String,List<String>>

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

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<KeyOperationResult>>

実装

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

例外

KeyVaultErrorException

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

SerializationException

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

ValidationException

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

ArgumentNullException

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

注釈

WRAP 操作では、Azure Key Vault に以前格納されたキーの暗号化キーを使用する対称キーの暗号化をサポートします。 厳密には、WRAP 操作が必要になるのは Azure Key Vault に格納されている対称キーの場合のみです。これは、非対称キーでの保護がキーのパブリックな部分を使用して実行できるためです。 この操作は、キー参照はあるが、パブリックのキー マテリアルにアクセスできない呼び出し元の利便性のために非対称キーでサポートされています。 この操作には、keys/wrapKey アクセス許可が必要です。