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

定義

名前空間:

Azure.Security.KeyVault.Keys

アセンブリ:

Azure.Security.KeyVault.Keys.dll

パッケージ:

Azure.Security.KeyVault.Keys v4.6.0

ソース:

KeyClient.cs

削除されたキーを最新バージョンに回復します。

public virtual Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation StartRecoverDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartRecoverDeletedKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation
override this.StartRecoverDeletedKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation

Public Overridable Function StartRecoverDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As RecoverDeletedKeyOperation

パラメーター

name

String

キーの名前です。

cancellationToken

CancellationToken

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

戻り値

RecoverDeletedKeyOperation

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

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

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