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

定義

名前空間:

Azure.Security.KeyVault.Keys

アセンブリ:

Azure.Security.KeyVault.Keys.dll

パッケージ:

Azure.Security.KeyVault.Keys v4.6.0

ソース:

KeyClient.cs

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

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation> StartDeleteKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
override this.StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>

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

パラメーター

name

String

キーの名前です。

cancellationToken

CancellationToken

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

戻り値

Task<DeleteKeyOperation>

DeleteKeyOperationこの実行時間の長い操作を待機する 。 Key Vaultが論理的な削除が有効になっている場合は、キーを回復または消去する必要がある場合にのみ操作が完了するまで待機する必要があります。それ以外の場合は、 でキーが自動的にScheduledPurgeDate削除されます。

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

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