KeyClient.GetKeyRotationPolicyAsync(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.

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

Task<Response<KeyRotationPolicy>>

A KeyRotationPolicy for the specified key.

Exceptions

ArgumentException

keyName contains an empty string.

ArgumentNullException

keyName is null.

RequestFailedException

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

Remarks

This operation requires the keys/get permission.

Applies to