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