Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

KeyClient.GetKeyAsync(String, String, CancellationToken) Method

Definition

Namespace:
Azure.Security.KeyVault.Keys
Assembly:
Azure.Security.KeyVault.Keys.dll
Package:
Azure.Security.KeyVault.Keys v4.10.0
Package:
Azure.Security.KeyVault.Keys v4.11.0-beta.1
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 public part of a stored key.

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

Parameters

name
String

The name of the key.

version
String

The version 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 get key operation is applicable to all key types. If the requested key is symmetric, then no key is released in the response. This operation requires the keys/get permission.

Applies to

Feedback

Was this page helpful?