ISshPublicKeysOperations.GenerateKeyPairWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.Compute

Assembly:: Microsoft.Azure.Management.Compute.dll

Package:: Microsoft.Azure.Management.Compute v61.0.0

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.

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.Models.SshPublicKeyGenerateKeyPairResult>> 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.Models.SshPublicKeyGenerateKeyPairResult>>

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 SshPublicKeyGenerateKeyPairResult))

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

Task<AzureOperationResponse<SshPublicKeyGenerateKeyPairResult>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Applies to