KeyVaultClientExtensions.DeleteKeyAsync メソッド

  • リファレンス

定義

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

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

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle> DeleteKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, System.Threading.CancellationToken cancellationToken = default);
static member DeleteKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle>
<Extension()>
Public Function DeleteKeyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeletedKeyBundle)

パラメーター

operations
IKeyVaultClient

この拡張メソッドの操作グループ。

vaultBaseUrl
String

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

keyName
String

削除するキーの名前。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<DeletedKeyBundle>

注釈

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

適用対象