KeyVaultClient.DeleteKeyWithHttpMessagesAsync メソッド

  • リファレンス

定義

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

Azure Key Vault のストレージから任意の種類のキーを削除します。

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle>> DeleteKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteKeyWithHttpMessagesAsync : string * string * 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.DeletedKeyBundle>>
override this.DeleteKeyWithHttpMessagesAsync : string * string * 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.DeletedKeyBundle>>
Public Function DeleteKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of DeletedKeyBundle))

パラメーター

vaultBaseUrl
String

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

keyName
String

削除するキーの名前。

customHeaders
Dictionary<String,List<String>>

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

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<DeletedKeyBundle>>

実装

DeleteKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

例外

KeyVaultErrorException

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

SerializationException

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

ValidationException

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

ArgumentNullException

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

注釈

キーの削除操作を使用して、キーの個々のバージョンを削除することはできません。 この操作ではキーに関連付けられている暗号化マテリアルを削除します。つまり、署名/検証、ラップ/ラップ解除または暗号化/暗号化解除の各操作でキーを使用できなくなります。 この操作には、keys/delete のアクセス許可が必要です。

適用対象