KeyClient.GetPropertiesOfKeyVersionsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

Lists the properties of all enabled and disabled versions of the specified key. You can use the returned Name and Version in subsequent calls to GetKeyAsync(String, String, CancellationToken).

public virtual Azure.AsyncPageable<Azure.Security.KeyVault.Keys.KeyProperties> GetPropertiesOfKeyVersionsAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetPropertiesOfKeyVersionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Security.KeyVault.Keys.KeyProperties>
override this.GetPropertiesOfKeyVersionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Security.KeyVault.Keys.KeyProperties>

Public Overridable Function GetPropertiesOfKeyVersionsAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of KeyProperties)

Parameters

name

String

The name of the key.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

AsyncPageable<KeyProperties>

Exceptions

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

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

Remarks

The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.