KeyVaultClient.GetKeyAsync Method (String, String, String, CancellationToken)

 

Asynchronously retrieves the public portion of a key plus its attributes.

Namespace:   Microsoft.Azure.KeyVault
Assembly:  Microsoft.Azure.KeyVault (in Microsoft.Azure.KeyVault.dll)

Syntax

public Task<KeyBundle> GetKeyAsync(
    string vault,
    string keyName,
    string keyVersion = null,
    CancellationToken cancellationToken = null
)

public:
Task<KeyBundle^>^ GetKeyAsync(
    String^ vault,
    String^ keyName,
    String^ keyVersion = null,
    CancellationToken cancellationToken = null
)

member GetKeyAsync : 
        vault:string *
        keyName:string *
        keyVersion:string = null *
        cancellationToken:CancellationToken = null -> Task<KeyBundle>

Public Function GetKeyAsync (
    vault As String,
    keyName As String,
    keyVersion As String,
    cancellationToken As CancellationToken
) As Task(Of KeyBundle)

Parameters

• vault
  Type: System.String

  The vault name, e.g. https://myvault.vault.azure.net.

• keyName
  Type: System.String

  The key name.

• keyVersion
  Type: System.String

  The key version.

• cancellationToken
  Type: System.Threading.CancellationToken

  Optional cancellation token.

Return Value

Type: System.Threading.Tasks.Task<KeyBundle>

A KeyBundle of the key and its attributes.

See Also

GetKeyAsync Overload
KeyVaultClient Class
Microsoft.Azure.KeyVault Namespace

Return to top