Share via


ISshPublicKeysOperations.GenerateKeyPairWithHttpMessagesAsync Method

Definition

Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Compute.Fluent.Models.SshPublicKeyGenerateKeyPairResultInner>> GenerateKeyPairWithHttpMessagesAsync (string resourceGroupName, string sshPublicKeyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GenerateKeyPairWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.Compute.Fluent.Models.SshPublicKeyGenerateKeyPairResultInner>>
Public Function GenerateKeyPairWithHttpMessagesAsync (resourceGroupName As String, sshPublicKeyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of SshPublicKeyGenerateKeyPairResultInner))

Parameters

resourceGroupName
String

The name of the resource group.

sshPublicKeyName
String

The name of the SSH public key.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to