SshPublicKeyCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.Compute

Assembly:

Azure.ResourceManager.Compute.dll

Package:

Azure.ResourceManager.Compute v1.16.0

Source:

SshPublicKeyCollection.cs

Tries to get details for this resource from the service.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}.
• Operation Id. : SshPublicKeyResources_Get.
• Default Api Version. : 2026-03-01.

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.SshPublicKeyResource>> GetIfExistsAsync(string sshPublicKeyName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.SshPublicKeyResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Compute.SshPublicKeyResource>>

Public Overridable Function GetIfExistsAsync (sshPublicKeyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of SshPublicKeyResource))

Parameters

sshPublicKeyName

String

The name of the SSH public key.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<SshPublicKeyResource>>

Exceptions

ArgumentNullException

sshPublicKeyName is null.

ArgumentException

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