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

定義

名前空間:

Azure.Security.KeyVault.Keys

アセンブリ:

Azure.Security.KeyVault.Keys.dll

パッケージ:

Azure.Security.KeyVault.Keys v4.6.0

ソース:

KeyClient.cs

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

public virtual System.Threading.Tasks.Task<Azure.Response> PurgeDeletedKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PurgeDeletedKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function PurgeDeletedKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

パラメーター

name

String

キーの名前です。

cancellationToken

CancellationToken

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

戻り値

Task<Response>

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

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