KeyClient.GetPropertiesOfKeyVersionsAsync(String, CancellationToken) Method
Definition
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.
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
Exceptions
name is an empty string.
name is null.
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.
