KeyClient.StartRecoverDeletedKeyAsync(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.Security.KeyVault.Keys.RecoverDeletedKeyOperation> StartRecoverDeletedKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

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

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

パラメーター

name

String

キーの名前です。

cancellationToken

CancellationToken

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

戻り値

Task<RecoverDeletedKeyOperation>

RecoverDeletedKeyOperationこの実行時間の長い操作を待機する 。

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

[削除されたキーの回復] 操作は、論理的な削除が有効なコンテナー内の削除済みキーに適用されます。 削除されたキーは、/keys の下の最新バージョンに回復されます。 削除されていないキーを回復しようとすると、エラーが返されます。 これは、論理的な削除が有効なコンテナーに対する削除操作の逆であると考えてください。 この操作には、キー/回復アクセス許可が必要です。