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

リファレンス

定義

名前空間:: Azure.Security.KeyVault.Keys

アセンブリ:: Azure.Security.KeyVault.Keys.dll

パッケージ:: Azure.Security.KeyVault.Keys v4.6.0

パッケージ:: Azure.Security.KeyVault.Keys v4.6.0-beta.2

ソース:: KeyClient.cs

ソース:: KeyClient.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

Key Vaultに新しいキーバージョンを作成し、それを格納してから、新しい KeyVaultKeyを返します。

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

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

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

パラメーター

name: String

回転するキーの名前。指定したキーに新しいバージョンが生成されます。

cancellationToken: CancellationToken

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

戻り値

Task<Response<KeyVaultKey>>

回転の KeyVaultKey新しいバージョン。

例外

ArgumentException

name には空の文字列が含まれています。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

操作では、キーポリシーに基づいてキーがローテーションされます。キー/ローテーションアクセス許可が必要です。

適用対象