KeyClient.RotateKey(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Keys

Assembly:: Azure.Security.KeyVault.Keys.dll

Package:: Azure.Security.KeyVault.Keys v4.6.0

Package:: Azure.Security.KeyVault.Keys v4.6.0-beta.2

Source:: KeyClient.cs

Source:: KeyClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a new key version in Key Vault, stores it, then returns the new KeyVaultKey.

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

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

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

Parameters

name: String

The name of key to be rotated. The system will generate a new version in the specified key.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<KeyVaultKey>

A new version of the rotate KeyVaultKey.

Exceptions

ArgumentException

name contains an empty string.

ArgumentNullException

name is null.

RequestFailedException

The server returned an error. See Message for details returned from the server.

Remarks

The operation will rotate the key based on the key policy. It requires the keys/rotate permission.

Applies to