ComputeExtensions.GetSshPublicKey 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-07-01
  • Resource: SshPublicKeyResource
public static Azure.Response<Azure.ResourceManager.Compute.SshPublicKeyResource> GetSshPublicKey (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string sshPublicKeyName, System.Threading.CancellationToken cancellationToken = default);
static member GetSshPublicKey : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.SshPublicKeyResource>
<Extension()>
Public Function GetSshPublicKey (resourceGroupResource As ResourceGroupResource, sshPublicKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SshPublicKeyResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

sshPublicKeyName
String

The name of the SSH public key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or sshPublicKeyName is null.

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

Applies to