SshPublicKeyCollection.GetAsync(String, CancellationToken) Method

Definition

Retrieves information about an SSH public key.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}
  • Operation Id: SshPublicKeys_Get
  • Default Api Version: 2024-03-01
  • Resource: SshPublicKeyResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.SshPublicKeyResource>> GetAsync (string sshPublicKeyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.SshPublicKeyResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.SshPublicKeyResource>>
Public Overridable Function GetAsync (sshPublicKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SshPublicKeyResource))

Parameters

sshPublicKeyName
String

The name of the SSH public key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

sshPublicKeyName is an empty string, and was expected to be non-empty.

sshPublicKeyName is null.

Applies to