KeyClient.PurgeDeletedKey(String, CancellationToken) メソッド

  • リファレンス

定義

名前空間:
Azure.Security.KeyVault.Keys
アセンブリ:
Azure.Security.KeyVault.Keys.dll
パッケージ:
Azure.Security.KeyVault.Keys v4.6.0
パッケージ:
Azure.Security.KeyVault.Keys v4.6.0-beta.2
ソース:
KeyClient.cs
ソース:
KeyClient.cs

指定したキーを完全に削除します。

public virtual Azure.Response PurgeDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response
override this.PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function PurgeDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response

パラメーター

name
String

キーの名前です。

cancellationToken
CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

Response

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。

注釈

削除されたキーの消去操作は、論理的な削除が有効なコンテナーに適用されます。 操作は任意のコンテナーで呼び出すことができますが、論理的な削除が有効になっていないコンテナーで呼び出されるとエラーが返されます。 この操作には、キー/消去アクセス許可が必要です。

適用対象