KeyClient.GetKey(String, String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Package:

Azure.Security.KeyVault.Keys v4.7.0

Source:

KeyClient.cs

Gets the public part of a stored key.

public virtual Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey> GetKey (string name, string version = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKey : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>
override this.GetKey : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>

Public Overridable Function GetKey (name As String, Optional version As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<KeyVaultKey>

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 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.