KeyClient.GetKeyRotationPolicyAsync(String, CancellationToken) Method

Definition

Gets the KeyRotationPolicy for the specified key in Key Vault.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyRotationPolicy>> GetKeyRotationPolicyAsync (string keyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetKeyRotationPolicyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyRotationPolicy>>
override this.GetKeyRotationPolicyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyRotationPolicy>>
Public Overridable Function GetKeyRotationPolicyAsync (keyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyRotationPolicy))

Parameters

keyName
String

The name of the key.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

A KeyRotationPolicy for the specified key.

Exceptions

keyName contains an empty string.

keyName is null.

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

Remarks

This operation requires the keys/get permission.

Applies to