ComputeExtensions.GetSshPublicKey Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.4.0

Package:: Azure.ResourceManager.Compute v1.5.0-beta.1

Source:: ComputeExtensions.cs

Source:: ComputeExtensions.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.

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: 2023-09-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

Response<SshPublicKeyResource>

Exceptions

ArgumentNullException

resourceGroupResource or sshPublicKeyName is null.

ArgumentException

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

Applies to