Share via


SshPublicKeyResource.GenerateKeyPairAsync 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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair
  • Operation Id: SshPublicKeys_GenerateKeyPair
  • Default Api Version: 2024-07-01
  • Resource: SshPublicKeyResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.Models.SshPublicKeyGenerateKeyPairResult>> GenerateKeyPairAsync (Azure.ResourceManager.Compute.Models.SshGenerateKeyPairInputContent content = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GenerateKeyPairAsync : Azure.ResourceManager.Compute.Models.SshGenerateKeyPairInputContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.Models.SshPublicKeyGenerateKeyPairResult>>
override this.GenerateKeyPairAsync : Azure.ResourceManager.Compute.Models.SshGenerateKeyPairInputContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.Models.SshPublicKeyGenerateKeyPairResult>>
Public Overridable Function GenerateKeyPairAsync (Optional content As SshGenerateKeyPairInputContent = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SshPublicKeyGenerateKeyPairResult))

Parameters

content
SshGenerateKeyPairInputContent

Parameters supplied to generate the SSH public key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Applies to