KeyClient.StartDeleteKeyAsync(String, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
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要求の有効期間を制御する 。
戻り値
DeleteKeyOperationこの実行時間の長い操作を待機する 。 Key Vaultが論理的な削除が有効になっている場合は、キーを回復または消去する必要がある場合にのみ操作が完了するまで待機する必要があります。それ以外の場合は、 でキーが自動的にScheduledPurgeDate削除されます。
例外
name
が空の文字列です。
name
が null です。
サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。
注釈
キーの削除操作を使用して、キーの個々のバージョンを削除することはできません。 この操作ではキーに関連付けられている暗号化マテリアルを削除します。つまり、署名/検証、ラップ/ラップ解除または暗号化/暗号化解除の各操作でキーを使用できなくなります。 この操作には、keys/delete のアクセス許可が必要です。
適用対象
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure SDK for .NET